← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-31 03:24:21 UTC
  • Revision ID: mbp@sourcefrog.net-20050331032421-a17c894e5d2382c4
add new explicit RootEntry to inventory (in-core only)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store.py
1
 
# Copyright (C) 2005 by Canonical Development Ltd
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
2
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
 
"""
18
 
Stores are the main data-storage mechanism for Bazaar-NG.
 
18
"""Stores are the main data-storage mechanism for Bazaar-NG.
19
19
 
20
20
A store is a simple write-once container indexed by a universally
21
 
unique ID.
22
 
"""
 
21
unique ID, which is typically the SHA-1 of the content."""
 
22
 
 
23
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
 
24
__author__ = "Martin Pool <mbp@canonical.com>"
23
25
 
24
26
import os, tempfile, types, osutils, gzip, errno
25
27
from stat import ST_SIZE
33
35
    pass
34
36
 
35
37
 
36
 
class ImmutableStore(object):
 
38
class ImmutableStore:
37
39
    """Store that holds files indexed by unique names.
38
40
 
39
41
    Files can be added, but not modified once they are in.  Typically
56
58
    >>> st['123123'].read()
57
59
    'goodbye'
58
60
 
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.
 
61
    :todo: Atomic add by writing to a temporary file and renaming.
 
62
 
 
63
    :todo: Perhaps automatically transform to/from XML in a method?
 
64
           Would just need to tell the constructor what class to
 
65
           use...
 
66
 
 
67
    :todo: Even within a simple disk store like this, we could
 
68
           gzip the files.  But since many are less than one disk
 
69
           block, that might not help a lot.
 
70
 
64
71
    """
65
72
 
66
73
    def __init__(self, basedir):
 
74
        """ImmutableStore constructor."""
67
75
        self._basedir = basedir
68
76
 
69
77
    def _path(self, id):
70
 
        if '\\' in id or '/' in id:
71
 
            raise ValueError("invalid store id %r" % id)
72
78
        return os.path.join(self._basedir, id)
73
79
 
74
80
    def __repr__(self):
77
83
    def add(self, f, fileid, compressed=True):
78
84
        """Add contents of a file into the store.
79
85
 
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
 
        
 
86
        :param 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.
85
90
        mutter("add store entry %r" % (fileid))
86
91
        if isinstance(f, types.StringTypes):
87
92
            content = f
88
93
        else:
89
94
            content = f.read()
90
 
            
 
95
 
91
96
        p = self._path(fileid)
92
97
        if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
93
 
            from bzrlib.errors import bailout
94
 
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
 
98
            bailout("store %r already contains id %r" % (self._basedir, fileid))
95
99
 
96
 
        fn = p
97
100
        if compressed:
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
 
    
 
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
 
155
110
 
156
111
    def __contains__(self, fileid):
157
112
        """"""
172
127
    def __len__(self):
173
128
        return len(os.listdir(self._basedir))
174
129
 
175
 
 
176
130
    def __getitem__(self, fileid):
177
131
        """Returns a file reading from a particular entry."""
178
132
        p = self._path(fileid)
179
133
        try:
180
134
            return gzip.GzipFile(p + '.gz', 'rb')
181
135
        except IOError, 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
 
 
 
136
            if e.errno == errno.ENOENT:
 
137
                return file(p, 'rb')
 
138
            else:
 
139
                raise e
193
140
 
194
141
    def total_size(self):
195
142
        """Return (count, bytes)
215
162
    """Self-destructing test subclass of ImmutableStore.
216
163
 
217
164
    The Store only exists for the lifetime of the Python object.
218
 
 Obviously you should not put anything precious in it.
 
165
    Obviously you should not put anything precious in it.
219
166
    """
220
167
    def __init__(self):
221
168
        ImmutableStore.__init__(self, tempfile.mkdtemp())
222
169
 
223
170
    def __del__(self):
224
171
        for f in os.listdir(self._basedir):
225
 
            fpath = os.path.join(self._basedir, f)
226
 
            # needed on windows, and maybe some other filesystems
227
 
            os.chmod(fpath, 0600)
228
 
            os.remove(fpath)
 
172
            os.remove(os.path.join(self._basedir, f))
229
173
        os.rmdir(self._basedir)
230
174
        mutter("%r destroyed" % self)