~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-08-29 04:23:53 UTC
  • Revision ID: mbp@sourcefrog.net-20050829042353-869333d329808a1e
- remove more extraneous print statements from Branch.move

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.trace import mutter
 
28
import bzrlib.ui
29
29
 
30
30
######################################################################
31
31
# stores
34
34
    pass
35
35
 
36
36
 
37
 
class ImmutableStore:
 
37
class ImmutableStore(object):
38
38
    """Store that holds files indexed by unique names.
39
39
 
40
40
    Files can be added, but not modified once they are in.  Typically
59
59
 
60
60
    TODO: Atomic add by writing to a temporary file and renaming.
61
61
 
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
 
 
 
62
    In bzr 0.0.5 and earlier, files within the store were marked
 
63
    readonly on disk.  This is no longer done but existing stores need
 
64
    to be accomodated.
70
65
    """
71
66
 
72
67
    def __init__(self, basedir):
73
 
        """ImmutableStore constructor."""
74
68
        self._basedir = basedir
75
69
 
76
70
    def _path(self, id):
 
71
        if '\\' in id or '/' in id:
 
72
            raise ValueError("invalid store id %r" % id)
77
73
        return os.path.join(self._basedir, id)
78
74
 
79
75
    def __repr__(self):
83
79
        """Add contents of a file into the store.
84
80
 
85
81
        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.
 
82
        # FIXME: Only works on files that will fit in memory
 
83
        
 
84
        from bzrlib.atomicfile import AtomicFile
 
85
        
89
86
        mutter("add store entry %r" % (fileid))
90
87
        if isinstance(f, types.StringTypes):
91
88
            content = f
92
89
        else:
93
90
            content = f.read()
94
 
 
 
91
            
95
92
        p = self._path(fileid)
96
93
        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))
 
94
            from bzrlib.errors import bailout
 
95
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
98
96
 
 
97
        fn = p
99
98
        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
 
 
 
99
            fn = fn + '.gz'
 
100
            
 
101
        af = AtomicFile(fn, 'wb')
 
102
        try:
 
103
            if compressed:
 
104
                gf = gzip.GzipFile(mode='wb', fileobj=af)
 
105
                gf.write(content)
 
106
                gf.close()
 
107
            else:
 
108
                af.write(content)
 
109
            af.commit()
 
110
        finally:
 
111
            af.close()
 
112
 
 
113
 
 
114
    def copy_multi(self, other, ids, permit_failure=False):
 
115
        """Copy texts for ids from other into self.
 
116
 
 
117
        If an id is present in self, it is skipped.
 
118
 
 
119
        Returns (count_copied, failed), where failed is a collection of ids
 
120
        that could not be copied.
 
121
        """
 
122
        pb = bzrlib.ui.ui_factory.progress_bar()
 
123
        
 
124
        pb.update('preparing to copy')
 
125
        to_copy = [id for id in ids if id not in self]
 
126
        if isinstance(other, ImmutableStore):
 
127
            return self.copy_multi_immutable(other, to_copy, pb)
 
128
        count = 0
 
129
        for id in to_copy:
 
130
            count += 1
 
131
            pb.update('copy', count, len(to_copy))
 
132
            if not permit_failure:
 
133
                self.add(other[id], id)
 
134
            else:
 
135
                try:
 
136
                    entry = other[id]
 
137
                except IndexError:
 
138
                    failures.add(id)
 
139
                    continue
 
140
                self.add(entry, id)
 
141
                
 
142
        assert count == len(to_copy)
 
143
        pb.clear()
 
144
        return count, []
 
145
 
 
146
 
 
147
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
 
148
        from shutil import copyfile
 
149
        count = 0
 
150
        failed = set()
 
151
        for id in to_copy:
 
152
            p = self._path(id)
 
153
            other_p = other._path(id)
 
154
            try:
 
155
                copyfile(other_p, p)
 
156
            except IOError, e:
 
157
                if e.errno == errno.ENOENT:
 
158
                    if not permit_failure:
 
159
                        copyfile(other_p+".gz", p+".gz")
 
160
                    else:
 
161
                        try:
 
162
                            copyfile(other_p+".gz", p+".gz")
 
163
                        except IOError, e:
 
164
                            if e.errno == errno.ENOENT:
 
165
                                failed.add(id)
 
166
                            else:
 
167
                                raise
 
168
                else:
 
169
                    raise
 
170
            
 
171
            count += 1
 
172
            pb.update('copy', count, len(to_copy))
 
173
        assert count == len(to_copy)
 
174
        pb.clear()
 
175
        return count, failed
 
176
    
109
177
 
110
178
    def __contains__(self, fileid):
111
179
        """"""
126
194
    def __len__(self):
127
195
        return len(os.listdir(self._basedir))
128
196
 
 
197
 
129
198
    def __getitem__(self, fileid):
130
199
        """Returns a file reading from a particular entry."""
131
200
        p = self._path(fileid)
132
201
        try:
133
202
            return gzip.GzipFile(p + '.gz', 'rb')
134
203
        except IOError, e:
135
 
            if e.errno == errno.ENOENT:
136
 
                return file(p, 'rb')
137
 
            else:
138
 
                raise e
 
204
            if e.errno != errno.ENOENT:
 
205
                raise
 
206
 
 
207
        try:
 
208
            return file(p, 'rb')
 
209
        except IOError, e:
 
210
            if e.errno != errno.ENOENT:
 
211
                raise
 
212
 
 
213
        raise IndexError(fileid)
 
214
 
139
215
 
140
216
    def total_size(self):
141
217
        """Return (count, bytes)
161
237
    """Self-destructing test subclass of ImmutableStore.
162
238
 
163
239
    The Store only exists for the lifetime of the Python object.
164
 
    Obviously you should not put anything precious in it.
 
240
 Obviously you should not put anything precious in it.
165
241
    """
166
242
    def __init__(self):
167
243
        ImmutableStore.__init__(self, tempfile.mkdtemp())