← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

merge merge tweaks from aaron, which includes latest .dev

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/store.py
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
 
1
# Copyright (C) 2005 by Canonical Development Ltd
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
"""Stores are the main data-storage mechanism for Bazaar-NG.
 
17
"""
 
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, which is typically the SHA-1 of the content."""
22
 
 
23
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
24
 
__author__ = "Martin Pool <mbp@canonical.com>"
 
21
unique ID.
 
22
"""
25
23
 
26
24
import os, tempfile, types, osutils, gzip, errno
27
25
from stat import ST_SIZE
28
26
from StringIO import StringIO
29
 
from trace import mutter
 
27
from bzrlib.errors import BzrError
 
28
from bzrlib.trace import mutter
 
29
import bzrlib.ui
30
30
 
31
31
######################################################################
32
32
# stores
35
35
    pass
36
36
 
37
37
 
38
 
class ImmutableStore:
 
38
class ImmutableStore(object):
39
39
    """Store that holds files indexed by unique names.
40
40
 
41
41
    Files can be added, but not modified once they are in.  Typically
58
58
    >>> st['123123'].read()
59
59
    'goodbye'
60
60
 
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
 
 
 
61
    TODO: Atomic add by writing to a temporary file and renaming.
 
62
 
 
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.
71
66
    """
72
67
 
73
68
    def __init__(self, basedir):
74
 
        """ImmutableStore constructor."""
75
69
        self._basedir = basedir
76
70
 
77
 
    def _path(self, id):
78
 
        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)
79
77
 
80
78
    def __repr__(self):
81
79
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
83
81
    def add(self, f, fileid, compressed=True):
84
82
        """Add contents of a file into the store.
85
83
 
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.
 
84
        f -- An open file, or file-like object."""
 
85
        # FIXME: Only works on files that will fit in memory
 
86
        
 
87
        from bzrlib.atomicfile import AtomicFile
 
88
        
90
89
        mutter("add store entry %r" % (fileid))
91
90
        if isinstance(f, types.StringTypes):
92
91
            content = f
93
92
        else:
94
93
            content = f.read()
95
 
 
 
94
            
96
95
        p = self._path(fileid)
97
96
        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))
 
97
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
99
98
 
 
99
        fn = p
100
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
 
 
 
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
                                             permit_failure=permit_failure)
 
131
        count = 0
 
132
        failed = set()
 
133
        for id in to_copy:
 
134
            count += 1
 
135
            pb.update('copy', count, len(to_copy))
 
136
            if not permit_failure:
 
137
                self.add(other[id], id)
 
138
            else:
 
139
                try:
 
140
                    entry = other[id]
 
141
                except KeyError:
 
142
                    failed.add(id)
 
143
                    continue
 
144
                self.add(entry, id)
 
145
                
 
146
        if not permit_failure:
 
147
            assert count == len(to_copy)
 
148
        pb.clear()
 
149
        return count, failed
 
150
 
 
151
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
 
152
        from shutil import copyfile
 
153
        count = 0
 
154
        failed = set()
 
155
        for id in to_copy:
 
156
            p = self._path(id)
 
157
            other_p = other._path(id)
 
158
            try:
 
159
                copyfile(other_p, p)
 
160
            except IOError, e:
 
161
                if e.errno == errno.ENOENT:
 
162
                    if not permit_failure:
 
163
                        copyfile(other_p+".gz", p+".gz")
 
164
                    else:
 
165
                        try:
 
166
                            copyfile(other_p+".gz", p+".gz")
 
167
                        except IOError, e:
 
168
                            if e.errno == errno.ENOENT:
 
169
                                failed.add(id)
 
170
                            else:
 
171
                                raise
 
172
                else:
 
173
                    raise
 
174
            
 
175
            count += 1
 
176
            pb.update('copy', count, len(to_copy))
 
177
        assert count == len(to_copy)
 
178
        pb.clear()
 
179
        return count, failed
 
180
    
110
181
 
111
182
    def __contains__(self, fileid):
112
183
        """"""
127
198
    def __len__(self):
128
199
        return len(os.listdir(self._basedir))
129
200
 
 
201
 
130
202
    def __getitem__(self, fileid):
131
203
        """Returns a file reading from a particular entry."""
132
204
        p = self._path(fileid)
133
205
        try:
134
206
            return gzip.GzipFile(p + '.gz', 'rb')
135
207
        except IOError, e:
136
 
            if e.errno == errno.ENOENT:
137
 
                return file(p, 'rb')
138
 
            else:
139
 
                raise e
 
208
            if e.errno != errno.ENOENT:
 
209
                raise
 
210
 
 
211
        try:
 
212
            return file(p, 'rb')
 
213
        except IOError, e:
 
214
            if e.errno != errno.ENOENT:
 
215
                raise
 
216
 
 
217
        raise KeyError(fileid)
 
218
 
140
219
 
141
220
    def total_size(self):
142
221
        """Return (count, bytes)
162
241
    """Self-destructing test subclass of ImmutableStore.
163
242
 
164
243
    The Store only exists for the lifetime of the Python object.
165
 
    Obviously you should not put anything precious in it.
 
244
 Obviously you should not put anything precious in it.
166
245
    """
167
246
    def __init__(self):
168
247
        ImmutableStore.__init__(self, tempfile.mkdtemp())
169
248
 
170
249
    def __del__(self):
171
250
        for f in os.listdir(self._basedir):
172
 
            os.remove(os.path.join(self._basedir, f))
 
251
            fpath = os.path.join(self._basedir, f)
 
252
            # needed on windows, and maybe some other filesystems
 
253
            os.chmod(fpath, 0600)
 
254
            os.remove(fpath)
173
255
        os.rmdir(self._basedir)
174
256
        mutter("%r destroyed" % self)