← 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-08-03 14:16:04 UTC
  • Revision ID: mbp@sourcefrog.net-20050803141604-b69a03512e094f37
- better summary help screen

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
34
33
    pass
35
34
 
36
35
 
37
 
class ImmutableStore:
 
36
class ImmutableStore(object):
38
37
    """Store that holds files indexed by unique names.
39
38
 
40
39
    Files can be added, but not modified once they are in.  Typically
59
58
 
60
59
    TODO: Atomic add by writing to a temporary file and renaming.
61
60
 
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
 
 
 
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.
70
64
    """
71
65
 
72
66
    def __init__(self, basedir):
73
 
        """ImmutableStore constructor."""
74
67
        self._basedir = basedir
75
68
 
76
69
    def _path(self, id):
 
70
        if '\\' in id or '/' in id:
 
71
            raise ValueError("invalid store id %r" % id)
77
72
        return os.path.join(self._basedir, id)
78
73
 
79
74
    def __repr__(self):
83
78
        """Add contents of a file into the store.
84
79
 
85
80
        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.
 
81
        # FIXME: Only works on files that will fit in memory
 
82
        
 
83
        from bzrlib.atomicfile import AtomicFile
 
84
        
89
85
        mutter("add store entry %r" % (fileid))
90
86
        if isinstance(f, types.StringTypes):
91
87
            content = f
92
88
        else:
93
89
            content = f.read()
94
 
 
 
90
            
95
91
        p = self._path(fileid)
96
92
        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))
 
93
            from bzrlib.errors import bailout
 
94
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
98
95
 
 
96
        fn = p
99
97
        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
 
 
 
98
            fn = fn + '.gz'
 
99
            
 
100
        af = AtomicFile(fn, 'wb')
 
101
        try:
 
102
            if compressed:
 
103
                gf = gzip.GzipFile(mode='wb', fileobj=af)
 
104
                gf.write(content)
 
105
                gf.close()
 
106
            else:
 
107
                af.write(content)
 
108
            af.commit()
 
109
        finally:
 
110
            af.close()
 
111
 
 
112
 
 
113
    def copy_multi(self, other, ids):
 
114
        """Copy texts for ids from other into self.
 
115
 
 
116
        If an id is present in self, it is skipped.  A count of copied
 
117
        ids is returned, which may be less than len(ids).
 
118
        """
 
119
        from bzrlib.progress import ProgressBar
 
120
        pb = ProgressBar()
 
121
        pb.update('preparing to copy')
 
122
        to_copy = [id for id in ids if id not in self]
 
123
        if isinstance(other, ImmutableStore):
 
124
            return self.copy_multi_immutable(other, to_copy, pb)
 
125
        count = 0
 
126
        for id in to_copy:
 
127
            count += 1
 
128
            pb.update('copy', count, len(to_copy))
 
129
            self.add(other[id], id)
 
130
        assert count == len(to_copy)
 
131
        pb.clear()
 
132
        return count
 
133
 
 
134
 
 
135
    def copy_multi_immutable(self, other, to_copy, pb):
 
136
        from shutil import copyfile
 
137
        count = 0
 
138
        for id in to_copy:
 
139
            p = self._path(id)
 
140
            other_p = other._path(id)
 
141
            try:
 
142
                copyfile(other_p, p)
 
143
            except IOError, e:
 
144
                if e.errno == errno.ENOENT:
 
145
                    copyfile(other_p+".gz", p+".gz")
 
146
                else:
 
147
                    raise
 
148
            
 
149
            count += 1
 
150
            pb.update('copy', count, len(to_copy))
 
151
        assert count == len(to_copy)
 
152
        pb.clear()
 
153
        return count
 
154
    
109
155
 
110
156
    def __contains__(self, fileid):
111
157
        """"""
126
172
    def __len__(self):
127
173
        return len(os.listdir(self._basedir))
128
174
 
 
175
 
129
176
    def __getitem__(self, fileid):
130
177
        """Returns a file reading from a particular entry."""
131
178
        p = self._path(fileid)
132
179
        try:
133
180
            return gzip.GzipFile(p + '.gz', 'rb')
134
181
        except IOError, e:
135
 
            if e.errno == errno.ENOENT:
136
 
                return file(p, 'rb')
137
 
            else:
138
 
                raise e
 
182
            if e.errno != errno.ENOENT:
 
183
                raise
 
184
 
 
185
        try:
 
186
            return file(p, 'rb')
 
187
        except IOError, e:
 
188
            if e.errno != errno.ENOENT:
 
189
                raise
 
190
 
 
191
        raise IndexError(fileid)
 
192
 
139
193
 
140
194
    def total_size(self):
141
195
        """Return (count, bytes)
161
215
    """Self-destructing test subclass of ImmutableStore.
162
216
 
163
217
    The Store only exists for the lifetime of the Python object.
164
 
    Obviously you should not put anything precious in it.
 
218
 Obviously you should not put anything precious in it.
165
219
    """
166
220
    def __init__(self):
167
221
        ImmutableStore.__init__(self, tempfile.mkdtemp())