← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Matt Nordhoff
  • Date: 2009-04-04 02:50:01 UTC
  • mfrom: (4253 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4256.
  • Revision ID: mnordhoff@mattnordhoff.com-20090404025001-z1403k0tatmc8l91
Merge bzr.dev, fixing conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
# TODO: Up-front, stat all files in order and remove those which are deleted or 
18
 
# out-of-date.  Don't actually re-read them until they're needed.  That ought 
19
 
# to bring all the inodes into core so that future stats to them are fast, and 
 
17
# TODO: Up-front, stat all files in order and remove those which are deleted or
 
18
# out-of-date.  Don't actually re-read them until they're needed.  That ought
 
19
# to bring all the inodes into core so that future stats to them are fast, and
20
20
# it preserves the nice property that any caller will always get up-to-date
21
21
# data except in unavoidable cases.
22
22
 
31
31
 
32
32
import os, stat, time
33
33
 
 
34
from bzrlib.filters import internal_size_sha_file_byname
34
35
from bzrlib.osutils import sha_file, sha_string, pathjoin, safe_unicode
35
36
from bzrlib.trace import mutter, warning
36
37
from bzrlib.atomicfile import AtomicFile
73
74
    hit_count
74
75
        number of times files have been retrieved from the cache, avoiding a
75
76
        re-read
76
 
        
 
77
 
77
78
    miss_count
78
79
        number of misses (times files have been completely re-read)
79
80
    """
80
81
    needs_write = False
81
82
 
82
 
    def __init__(self, root, cache_file_name, mode=None):
83
 
        """Create a hash cache in base dir, and set the file mode to mode."""
 
83
    def __init__(self, root, cache_file_name, mode=None,
 
84
            content_filter_stack_provider=None):
 
85
        """Create a hash cache in base dir, and set the file mode to mode.
 
86
 
 
87
        :param content_filter_stack_provider: a function that takes a
 
88
            path (relative to the top of the tree) and a file-id as
 
89
            parameters and returns a stack of ContentFilters.
 
90
            If None, no content filtering is performed.
 
91
        """
84
92
        self.root = safe_unicode(root)
85
93
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
86
94
        self.hit_count = 0
92
100
        self._cache = {}
93
101
        self._mode = mode
94
102
        self._cache_file_name = safe_unicode(cache_file_name)
 
103
        self._filter_provider = content_filter_stack_provider
95
104
 
96
105
    def cache_file_name(self):
97
106
        return self._cache_file_name
106
115
 
107
116
    def scan(self):
108
117
        """Scan all files and remove entries where the cache entry is obsolete.
109
 
        
 
118
 
110
119
        Obsolete entries are those where the file has been modified or deleted
111
 
        since the entry was inserted.        
 
120
        since the entry was inserted.
112
121
        """
113
122
        # FIXME optimisation opportunity, on linux [and check other oses]:
114
123
        # rather than iteritems order, stat in inode order.
115
124
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
116
125
        prep.sort()
117
 
        
 
126
 
118
127
        for inum, path, cache_entry in prep:
119
128
            abspath = pathjoin(self.root, path)
120
129
            fp = self._fingerprint(abspath)
121
130
            self.stat_count += 1
122
 
            
 
131
 
123
132
            cache_fp = cache_entry[1]
124
 
    
 
133
 
125
134
            if (not fp) or (cache_fp != fp):
126
135
                # not here or not a regular file anymore
127
136
                self.removed_count += 1
137
146
            abspath = pathjoin(self.root, path)
138
147
        self.stat_count += 1
139
148
        file_fp = self._fingerprint(abspath, stat_value)
140
 
        
 
149
 
141
150
        if not file_fp:
142
151
            # not a regular file or not existing
143
152
            if path in self._cache:
144
153
                self.removed_count += 1
145
154
                self.needs_write = True
146
155
                del self._cache[path]
147
 
            return None        
 
156
            return None
148
157
 
149
158
        if path in self._cache:
150
159
            cache_sha1, cache_fp = self._cache[path]
156
165
            ## mutter("now = %s", time.time())
157
166
            self.hit_count += 1
158
167
            return cache_sha1
159
 
        
 
168
 
160
169
        self.miss_count += 1
161
170
 
162
171
        mode = file_fp[FP_MODE_COLUMN]
163
172
        if stat.S_ISREG(mode):
164
 
            digest = self._really_sha1_file(abspath)
 
173
            if self._filter_provider is None:
 
174
                filters = []
 
175
            else:
 
176
                filters = self._filter_provider(path=path, file_id=None)
 
177
            digest = self._really_sha1_file(abspath, filters)
165
178
        elif stat.S_ISLNK(mode):
166
179
            digest = sha_string(os.readlink(abspath))
167
180
        else:
198
211
            self._cache[path] = (digest, file_fp)
199
212
        return digest
200
213
 
201
 
    def _really_sha1_file(self, abspath):
 
214
    def _really_sha1_file(self, abspath, filters):
202
215
        """Calculate the SHA1 of a file by reading the full text"""
203
 
        return sha_file(file(abspath, 'rb', buffering=65000))
204
 
        
 
216
        return internal_size_sha_file_byname(abspath, filters)[1]
 
217
 
205
218
    def write(self):
206
219
        """Write contents of cache to file."""
207
220
        outf = AtomicFile(self.cache_file_name(), 'wb', new_mode=self._mode)
227
240
 
228
241
        Overwrites existing cache.
229
242
 
230
 
        If the cache file has the wrong version marker, this just clears 
 
243
        If the cache file has the wrong version marker, this just clears
231
244
        the cache."""
232
245
        self._cache = {}
233
246
 
278
291
        undetectably modified and so can't be cached.
279
292
        """
280
293
        return int(time.time()) - 3
281
 
           
 
294
 
282
295
    def _fingerprint(self, abspath, stat_value=None):
283
296
        if stat_value is None:
284
297
            try:
291
304
        # we discard any high precision because it's not reliable; perhaps we
292
305
        # could do better on some systems?
293
306
        return (stat_value.st_size, long(stat_value.st_mtime),
294
 
                long(stat_value.st_ctime), stat_value.st_ino, 
 
307
                long(stat_value.st_ctime), stat_value.st_ino,
295
308
                stat_value.st_dev, stat_value.st_mode)