← 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-07-11 07:05:34 UTC
  • Revision ID: mbp@sourcefrog.net-20050711070534-5227696ab167ccde
- merge aaron's append_multiple.patch

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
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):
83
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
 
 
 
90
            
96
91
        p = self._path(fileid)
97
92
        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))
 
93
            raise BzrError("store %r already contains id %r" % (self._basedir, fileid))
99
94
 
 
95
        fn = p
100
96
        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
 
 
 
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
        if isinstance(other, ImmutableStore):
 
123
            return self.copy_multi_immutable(other, to_copy, pb)
 
124
        count = 0
 
125
        for id in to_copy:
 
126
            count += 1
 
127
            pb.update('copy', count, len(to_copy))
 
128
            self.add(other[id], id)
 
129
        assert count == len(to_copy)
 
130
        pb.clear()
 
131
        return count
 
132
 
 
133
 
 
134
    def copy_multi_immutable(self, other, to_copy, pb):
 
135
        from shutil import copyfile
 
136
        count = 0
 
137
        for id in to_copy:
 
138
            p = self._path(id)
 
139
            other_p = other._path(id)
 
140
            try:
 
141
                copyfile(other_p, p)
 
142
            except IOError, e:
 
143
                if e.errno == errno.ENOENT:
 
144
                    copyfile(other_p+".gz", p+".gz")
 
145
                else:
 
146
                    raise
 
147
            
 
148
            count += 1
 
149
            pb.update('copy', count, len(to_copy))
 
150
        assert count == len(to_copy)
 
151
        pb.clear()
 
152
        return count
 
153
    
110
154
 
111
155
    def __contains__(self, fileid):
112
156
        """"""
162
206
    """Self-destructing test subclass of ImmutableStore.
163
207
 
164
208
    The Store only exists for the lifetime of the Python object.
165
 
    Obviously you should not put anything precious in it.
 
209
 Obviously you should not put anything precious in it.
166
210
    """
167
211
    def __init__(self):
168
212
        ImmutableStore.__init__(self, tempfile.mkdtemp())
169
213
 
170
214
    def __del__(self):
171
215
        for f in os.listdir(self._basedir):
172
 
            os.remove(os.path.join(self._basedir, f))
 
216
            fpath = os.path.join(self._basedir, f)
 
217
            # needed on windows, and maybe some other filesystems
 
218
            os.chmod(fpath, 0600)
 
219
            os.remove(fpath)
173
220
        os.rmdir(self._basedir)
174
221
        mutter("%r destroyed" % self)