← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/store.py

  • Committer: Martin Pool
  • Date: 2005-06-22 03:09:57 UTC
  • Revision ID: mbp@sourcefrog.net-20050622030957-692ff24093ce2a86
- add help, try, apply options to pwk script

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>"
25
 
 
26
 
import os, tempfile, types, osutils
 
21
unique ID.
 
22
"""
 
23
 
 
24
import os, tempfile, types, osutils, gzip, errno
 
25
from stat import ST_SIZE
27
26
from StringIO import StringIO
28
27
from trace import mutter
29
28
 
30
 
 
31
29
######################################################################
32
30
# stores
33
31
 
35
33
    pass
36
34
 
37
35
 
38
 
class ImmutableStore:
 
36
class ImmutableStore(object):
39
37
    """Store that holds files indexed by unique names.
40
38
 
41
39
    Files can be added, but not modified once they are in.  Typically
58
56
    >>> st['123123'].read()
59
57
    'goodbye'
60
58
 
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
 
 
 
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.
71
64
    """
72
65
 
73
66
    def __init__(self, basedir):
74
 
        """ImmutableStore constructor."""
75
67
        self._basedir = basedir
76
68
 
77
69
    def _path(self, id):
 
70
        if '\\' in id or '/' in id:
 
71
            raise ValueError("invalid store id %r" % id)
78
72
        return os.path.join(self._basedir, id)
79
73
 
80
74
    def __repr__(self):
81
75
        return "%s(%r)" % (self.__class__.__name__, self._basedir)
82
76
 
83
 
    def add(self, f, fileid):
 
77
    def add(self, f, fileid, compressed=True):
84
78
        """Add contents of a file into the store.
85
79
 
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.
 
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
        
90
85
        mutter("add store entry %r" % (fileid))
91
86
        if isinstance(f, types.StringTypes):
92
87
            content = f
93
88
        else:
94
89
            content = f.read()
95
 
        if fileid not in self:
96
 
            filename = self._path(fileid)
97
 
            f = file(filename, 'wb')
98
 
            f.write(content)
99
 
            f.flush()
100
 
            os.fsync(f.fileno())
101
 
            f.close()
102
 
            osutils.make_readonly(filename)
103
 
 
 
90
            
 
91
        p = self._path(fileid)
 
92
        if os.access(p, os.F_OK) or os.access(p + '.gz', os.F_OK):
 
93
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
 
94
 
 
95
        fn = p
 
96
        if compressed:
 
97
            fn = fn + '.gz'
 
98
            
 
99
        af = AtomicFile(fn, 'wb')
 
100
        try:
 
101
            if compressed:
 
102
                gf = gzip.GzipFile(mode='wb', fileobj=af)
 
103
                gf.write(content)
 
104
                gf.close()
 
105
            else:
 
106
                af.write(content)
 
107
            af.commit()
 
108
        finally:
 
109
            af.close()
 
110
 
 
111
 
 
112
    def copy_multi(self, other, ids):
 
113
        """Copy texts for ids from other into self.
 
114
 
 
115
        If an id is present in self, it is skipped.  A count of copied
 
116
        ids is returned, which may be less than len(ids).
 
117
        """
 
118
        from bzrlib.progress import ProgressBar
 
119
        pb = ProgressBar()
 
120
        pb.update('preparing to copy')
 
121
        to_copy = [id for id in ids if id not in self]
 
122
        count = 0
 
123
        for id in to_copy:
 
124
            count += 1
 
125
            pb.update('copy', count, len(to_copy))
 
126
            self.add(other[id], id)
 
127
        assert count == len(to_copy)
 
128
        pb.clear()
 
129
        return count
 
130
    
104
131
 
105
132
    def __contains__(self, fileid):
106
133
        """"""
107
 
        return os.access(self._path(fileid), os.R_OK)
 
134
        p = self._path(fileid)
 
135
        return (os.access(p, os.R_OK)
 
136
                or os.access(p + '.gz', os.R_OK))
108
137
 
 
138
    # TODO: Guard against the same thing being stored twice, compressed and uncompresse
109
139
 
110
140
    def __iter__(self):
111
 
        return iter(os.listdir(self._basedir))
 
141
        for f in os.listdir(self._basedir):
 
142
            if f[-3:] == '.gz':
 
143
                # TODO: case-insensitive?
 
144
                yield f[:-3]
 
145
            else:
 
146
                yield f
 
147
 
 
148
    def __len__(self):
 
149
        return len(os.listdir(self._basedir))
112
150
 
113
151
    def __getitem__(self, fileid):
114
152
        """Returns a file reading from a particular entry."""
115
 
        return file(self._path(fileid), 'rb')
116
 
 
117
 
    def delete_all(self):
118
 
        for fileid in self:
119
 
            self.delete(fileid)
120
 
 
121
 
    def delete(self, fileid):
122
 
        """Remove nominated store entry.
123
 
 
124
 
        Most stores will be add-only."""
125
 
        filename = self._path(fileid)
126
 
        ## osutils.make_writable(filename)
127
 
        os.remove(filename)
128
 
 
129
 
    def destroy(self):
130
 
        """Remove store; only allowed if it is empty."""
131
 
        os.rmdir(self._basedir)
132
 
        mutter("%r destroyed" % self)
 
153
        p = self._path(fileid)
 
154
        try:
 
155
            return gzip.GzipFile(p + '.gz', 'rb')
 
156
        except IOError, e:
 
157
            if e.errno == errno.ENOENT:
 
158
                return file(p, 'rb')
 
159
            else:
 
160
                raise e
 
161
 
 
162
    def total_size(self):
 
163
        """Return (count, bytes)
 
164
 
 
165
        This is the (compressed) size stored on disk, not the size of
 
166
        the content."""
 
167
        total = 0
 
168
        count = 0
 
169
        for fid in self:
 
170
            count += 1
 
171
            p = self._path(fid)
 
172
            try:
 
173
                total += os.stat(p)[ST_SIZE]
 
174
            except OSError:
 
175
                total += os.stat(p + '.gz')[ST_SIZE]
 
176
                
 
177
        return count, total
 
178
 
133
179
 
134
180
 
135
181
 
137
183
    """Self-destructing test subclass of ImmutableStore.
138
184
 
139
185
    The Store only exists for the lifetime of the Python object.
140
 
    Obviously you should not put anything precious in it.
 
186
 Obviously you should not put anything precious in it.
141
187
    """
142
188
    def __init__(self):
143
189
        ImmutableStore.__init__(self, tempfile.mkdtemp())
144
190
 
145
191
    def __del__(self):
146
 
        self.delete_all()
147
 
        self.destroy()
 
192
        for f in os.listdir(self._basedir):
 
193
            fpath = os.path.join(self._basedir, f)
 
194
            # needed on windows, and maybe some other filesystems
 
195
            os.chmod(fpath, 0600)
 
196
            os.remove(fpath)
 
197
        os.rmdir(self._basedir)
 
198
        mutter("%r destroyed" % self)