~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Robert Collins
  • Date: 2005-09-23 09:25:16 UTC
  • mto: (1092.3.4)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: robertc@robertcollins.net-20050923092516-e2c3c0f31288669d
Merge what applied of Alexander Belchenko's win32 patch.

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.errors import BzrError
 
28
from bzrlib.trace import mutter
 
29
import bzrlib.ui
29
30
 
30
31
######################################################################
31
32
# stores
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
 
        assert '/' not in 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)
84
82
        """Add contents of a file into the store.
85
83
 
86
84
        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
        # 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)
 
101
            fn = fn + '.gz'
106
102
            
107
 
        f.write(content)
108
 
        f.close()
109
 
 
110
 
 
111
 
    def copy_multi(self, other, ids):
 
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):
112
117
        """Copy texts for ids from other into self.
113
118
 
114
 
        If an id is present in self, it is skipped.  A count of copied
115
 
        ids is returned, which may be less than len(ids).
 
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.
116
123
        """
117
 
        from bzrlib.progress import ProgressBar
118
 
        pb = ProgressBar()
 
124
        pb = bzrlib.ui.ui_factory.progress_bar()
 
125
        
119
126
        pb.update('preparing to copy')
120
127
        to_copy = [id for id in ids if id not in self]
121
 
        count = 0
122
 
        for id in to_copy:
123
 
            count += 1
124
 
            pb.update('copy', count, len(to_copy))
125
 
            self.add(other[id], id)
 
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))
126
177
        assert count == len(to_copy)
127
178
        pb.clear()
128
 
        return count
 
179
        return count, failed
129
180
    
130
181
 
131
182
    def __contains__(self, fileid):
147
198
    def __len__(self):
148
199
        return len(os.listdir(self._basedir))
149
200
 
 
201
 
150
202
    def __getitem__(self, fileid):
151
203
        """Returns a file reading from a particular entry."""
152
204
        p = self._path(fileid)
153
205
        try:
154
206
            return gzip.GzipFile(p + '.gz', 'rb')
155
207
        except IOError, e:
156
 
            if e.errno == errno.ENOENT:
157
 
                return file(p, 'rb')
158
 
            else:
159
 
                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
 
160
219
 
161
220
    def total_size(self):
162
221
        """Return (count, bytes)
182
241
    """Self-destructing test subclass of ImmutableStore.
183
242
 
184
243
    The Store only exists for the lifetime of the Python object.
185
 
    Obviously you should not put anything precious in it.
 
244
 Obviously you should not put anything precious in it.
186
245
    """
187
246
    def __init__(self):
188
247
        ImmutableStore.__init__(self, tempfile.mkdtemp())