← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Robert Collins
  • Date: 2005-08-25 12:46:42 UTC
  • mfrom: (1116)
  • mto: (974.1.50) (1185.1.10) (1092.3.1)
  • mto: This revision was merged to the branch mainline in revision 1139.
  • Revision ID: robertc@robertcollins.net-20050825124642-45ed1cd74db10370
merge from mpool

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.trace import mutter
 
28
import bzrlib.ui
30
29
 
31
30
######################################################################
32
31
# stores
35
34
    pass
36
35
 
37
36
 
38
 
class ImmutableStore:
 
37
class ImmutableStore(object):
39
38
    """Store that holds files indexed by unique names.
40
39
 
41
40
    Files can be added, but not modified once they are in.  Typically
58
57
    >>> st['123123'].read()
59
58
    'goodbye'
60
59
 
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
 
 
 
60
    TODO: Atomic add by writing to a temporary file and renaming.
 
61
 
 
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.
71
65
    """
72
66
 
73
67
    def __init__(self, basedir):
74
 
        """ImmutableStore constructor."""
75
68
        self._basedir = basedir
76
69
 
77
70
    def _path(self, id):
 
71
        if '\\' in id or '/' in id:
 
72
            raise ValueError("invalid store id %r" % id)
78
73
        return os.path.join(self._basedir, id)
79
74
 
80
75
    def __repr__(self):
83
78
    def add(self, f, fileid, compressed=True):
84
79
        """Add contents of a file into the store.
85
80
 
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.
 
81
        f -- An open file, or file-like object."""
 
82
        # FIXME: Only works on files that will fit in memory
 
83
        
 
84
        from bzrlib.atomicfile import AtomicFile
 
85
        
90
86
        mutter("add store entry %r" % (fileid))
91
87
        if isinstance(f, types.StringTypes):
92
88
            content = f
93
89
        else:
94
90
            content = f.read()
95
 
 
 
91
            
96
92
        p = self._path(fileid)
97
93
        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))
 
94
            from bzrlib.errors import bailout
 
95
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
99
96
 
 
97
        fn = p
100
98
        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
 
 
 
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
    def copy_multi_immutable(self, other, to_copy, pb, permit_failure=False):
 
147
        from shutil import copyfile
 
148
        count = 0
 
149
        failed = set()
 
150
        for id in to_copy:
 
151
            p = self._path(id)
 
152
            other_p = other._path(id)
 
153
            try:
 
154
                copyfile(other_p, p)
 
155
            except IOError, e:
 
156
                if e.errno == errno.ENOENT:
 
157
                    if not permit_failure:
 
158
                        copyfile(other_p+".gz", p+".gz")
 
159
                    else:
 
160
                        try:
 
161
                            copyfile(other_p+".gz", p+".gz")
 
162
                        except IOError, e:
 
163
                            if e.errno == errno.ENOENT:
 
164
                                failed.add(id)
 
165
                            else:
 
166
                                raise
 
167
                else:
 
168
                    raise
 
169
            
 
170
            count += 1
 
171
            pb.update('copy', count, len(to_copy))
 
172
        assert count == len(to_copy)
 
173
        pb.clear()
 
174
        return count, failed
 
175
    
110
176
 
111
177
    def __contains__(self, fileid):
112
178
        """"""
127
193
    def __len__(self):
128
194
        return len(os.listdir(self._basedir))
129
195
 
 
196
 
130
197
    def __getitem__(self, fileid):
131
198
        """Returns a file reading from a particular entry."""
132
199
        p = self._path(fileid)
133
200
        try:
134
201
            return gzip.GzipFile(p + '.gz', 'rb')
135
202
        except IOError, e:
136
 
            if e.errno == errno.ENOENT:
137
 
                return file(p, 'rb')
138
 
            else:
139
 
                raise e
 
203
            if e.errno != errno.ENOENT:
 
204
                raise
 
205
 
 
206
        try:
 
207
            return file(p, 'rb')
 
208
        except IOError, e:
 
209
            if e.errno != errno.ENOENT:
 
210
                raise
 
211
 
 
212
        raise IndexError(fileid)
 
213
 
140
214
 
141
215
    def total_size(self):
142
216
        """Return (count, bytes)
162
236
    """Self-destructing test subclass of ImmutableStore.
163
237
 
164
238
    The Store only exists for the lifetime of the Python object.
165
 
    Obviously you should not put anything precious in it.
 
239
 Obviously you should not put anything precious in it.
166
240
    """
167
241
    def __init__(self):
168
242
        ImmutableStore.__init__(self, tempfile.mkdtemp())
169
243
 
170
244
    def __del__(self):
171
245
        for f in os.listdir(self._basedir):
172
 
            os.remove(os.path.join(self._basedir, f))
 
246
            fpath = os.path.join(self._basedir, f)
 
247
            # needed on windows, and maybe some other filesystems
 
248
            os.chmod(fpath, 0600)
 
249
            os.remove(fpath)
173
250
        os.rmdir(self._basedir)
174
251
        mutter("%r destroyed" % self)