/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/hashcache.py

  • Committer: Vincent Ladeuil
  • Date: 2009-04-27 16:10:10 UTC
  • mto: (4310.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4311.
  • Revision ID: v.ladeuil+lp@free.fr-20090427161010-7swfzeagf63cpixd
Fix bug #367726 by reverting some default user handling introduced
while fixing bug #256612.

* bzrlib/transport/ssh.py:
(_paramiko_auth): Explicitly use getpass.getuser() as default
user.

* bzrlib/transport/ftp/_gssapi.py:
(GSSAPIFtpTransport._create_connection): Explicitly use
getpass.getuser() as default user.

* bzrlib/transport/ftp/__init__.py:
(FtpTransport._create_connection): Explicitly use
getpass.getuser() as default user.

* bzrlib/tests/test_sftp_transport.py:
(TestUsesAuthConfig.test_sftp_is_none_if_no_config)
(TestUsesAuthConfig.test_sftp_doesnt_prompt_username): Revert to
None as the default user.

* bzrlib/tests/test_remote.py:
(TestRemoteSSHTransportAuthentication): The really offending one:
revert to None as the default user.

* bzrlib/tests/test_config.py:
(TestAuthenticationConfig.test_username_default_no_prompt): Update
test (and some PEP8).

* bzrlib/smtp_connection.py:
(SMTPConnection._authenticate): Revert to None as the default
user.

* bzrlib/plugins/launchpad/account.py:
(_get_auth_user): Revert default value handling.

* bzrlib/config.py:
(AuthenticationConfig.get_user): Fix doc-string. Leave default
value handling to callers.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/hashcache.py
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
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
 
20
# it preserves the nice property that any caller will always get up-to-date
 
21
# data except in unavoidable cases.
 
22
 
 
23
# TODO: Perhaps return more details on the file to avoid statting it
 
24
# again: nonexistent, file type, size, etc
 
25
 
 
26
# TODO: Perhaps use a Python pickle instead of a text file; might be faster.
 
27
 
 
28
 
 
29
 
 
30
CACHE_HEADER = "### bzr hashcache v5\n"
 
31
 
 
32
import os
 
33
import stat
 
34
import time
 
35
 
 
36
from bzrlib import (
 
37
    atomicfile,
 
38
    errors,
 
39
    filters as _mod_filters,
 
40
    osutils,
 
41
    trace,
 
42
    )
 
43
 
 
44
 
 
45
FP_MTIME_COLUMN = 1
 
46
FP_CTIME_COLUMN = 2
 
47
FP_MODE_COLUMN = 5
 
48
 
 
49
 
 
50
 
 
51
class HashCache(object):
 
52
    """Cache for looking up file SHA-1.
 
53
 
 
54
    Files are considered to match the cached value if the fingerprint
 
55
    of the file has not changed.  This includes its mtime, ctime,
 
56
    device number, inode number, and size.  This should catch
 
57
    modifications or replacement of the file by a new one.
 
58
 
 
59
    This may not catch modifications that do not change the file's
 
60
    size and that occur within the resolution window of the
 
61
    timestamps.  To handle this we specifically do not cache files
 
62
    which have changed since the start of the present second, since
 
63
    they could undetectably change again.
 
64
 
 
65
    This scheme may fail if the machine's clock steps backwards.
 
66
    Don't do that.
 
67
 
 
68
    This does not canonicalize the paths passed in; that should be
 
69
    done by the caller.
 
70
 
 
71
    _cache
 
72
        Indexed by path, points to a two-tuple of the SHA-1 of the file.
 
73
        and its fingerprint.
 
74
 
 
75
    stat_count
 
76
        number of times files have been statted
 
77
 
 
78
    hit_count
 
79
        number of times files have been retrieved from the cache, avoiding a
 
80
        re-read
 
81
 
 
82
    miss_count
 
83
        number of misses (times files have been completely re-read)
 
84
    """
 
85
    needs_write = False
 
86
 
 
87
    def __init__(self, root, cache_file_name, mode=None,
 
88
            content_filter_stack_provider=None):
 
89
        """Create a hash cache in base dir, and set the file mode to mode.
 
90
 
 
91
        :param content_filter_stack_provider: a function that takes a
 
92
            path (relative to the top of the tree) and a file-id as
 
93
            parameters and returns a stack of ContentFilters.
 
94
            If None, no content filtering is performed.
 
95
        """
 
96
        self.root = osutils.safe_unicode(root)
 
97
        self.root_utf8 = self.root.encode('utf8') # where is the filesystem encoding ?
 
98
        self.hit_count = 0
 
99
        self.miss_count = 0
 
100
        self.stat_count = 0
 
101
        self.danger_count = 0
 
102
        self.removed_count = 0
 
103
        self.update_count = 0
 
104
        self._cache = {}
 
105
        self._mode = mode
 
106
        self._cache_file_name = osutils.safe_unicode(cache_file_name)
 
107
        self._filter_provider = content_filter_stack_provider
 
108
 
 
109
    def cache_file_name(self):
 
110
        return self._cache_file_name
 
111
 
 
112
    def clear(self):
 
113
        """Discard all cached information.
 
114
 
 
115
        This does not reset the counters."""
 
116
        if self._cache:
 
117
            self.needs_write = True
 
118
            self._cache = {}
 
119
 
 
120
    def scan(self):
 
121
        """Scan all files and remove entries where the cache entry is obsolete.
 
122
 
 
123
        Obsolete entries are those where the file has been modified or deleted
 
124
        since the entry was inserted.
 
125
        """
 
126
        # FIXME optimisation opportunity, on linux [and check other oses]:
 
127
        # rather than iteritems order, stat in inode order.
 
128
        prep = [(ce[1][3], path, ce) for (path, ce) in self._cache.iteritems()]
 
129
        prep.sort()
 
130
 
 
131
        for inum, path, cache_entry in prep:
 
132
            abspath = osutils.pathjoin(self.root, path)
 
133
            fp = self._fingerprint(abspath)
 
134
            self.stat_count += 1
 
135
 
 
136
            cache_fp = cache_entry[1]
 
137
 
 
138
            if (not fp) or (cache_fp != fp):
 
139
                # not here or not a regular file anymore
 
140
                self.removed_count += 1
 
141
                self.needs_write = True
 
142
                del self._cache[path]
 
143
 
 
144
    def get_sha1(self, path, stat_value=None):
 
145
        """Return the sha1 of a file.
 
146
        """
 
147
        if path.__class__ is str:
 
148
            abspath = osutils.pathjoin(self.root_utf8, path)
 
149
        else:
 
150
            abspath = osutils.pathjoin(self.root, path)
 
151
        self.stat_count += 1
 
152
        file_fp = self._fingerprint(abspath, stat_value)
 
153
 
 
154
        if not file_fp:
 
155
            # not a regular file or not existing
 
156
            if path in self._cache:
 
157
                self.removed_count += 1
 
158
                self.needs_write = True
 
159
                del self._cache[path]
 
160
            return None
 
161
 
 
162
        if path in self._cache:
 
163
            cache_sha1, cache_fp = self._cache[path]
 
164
        else:
 
165
            cache_sha1, cache_fp = None, None
 
166
 
 
167
        if cache_fp == file_fp:
 
168
            ## mutter("hashcache hit for %s %r -> %s", path, file_fp, cache_sha1)
 
169
            ## mutter("now = %s", time.time())
 
170
            self.hit_count += 1
 
171
            return cache_sha1
 
172
 
 
173
        self.miss_count += 1
 
174
 
 
175
        mode = file_fp[FP_MODE_COLUMN]
 
176
        if stat.S_ISREG(mode):
 
177
            if self._filter_provider is None:
 
178
                filters = []
 
179
            else:
 
180
                filters = self._filter_provider(path=path, file_id=None)
 
181
            digest = self._really_sha1_file(abspath, filters)
 
182
        elif stat.S_ISLNK(mode):
 
183
            digest = osutils.sha_string(os.readlink(abspath))
 
184
        else:
 
185
            raise errors.BzrError("file %r: unknown file stat mode: %o"
 
186
                                  % (abspath, mode))
 
187
 
 
188
        # window of 3 seconds to allow for 2s resolution on windows,
 
189
        # unsynchronized file servers, etc.
 
190
        cutoff = self._cutoff_time()
 
191
        if file_fp[FP_MTIME_COLUMN] >= cutoff \
 
192
                or file_fp[FP_CTIME_COLUMN] >= cutoff:
 
193
            # changed too recently; can't be cached.  we can
 
194
            # return the result and it could possibly be cached
 
195
            # next time.
 
196
            #
 
197
            # the point is that we only want to cache when we are sure that any
 
198
            # subsequent modifications of the file can be detected.  If a
 
199
            # modification neither changes the inode, the device, the size, nor
 
200
            # the mode, then we can only distinguish it by time; therefore we
 
201
            # need to let sufficient time elapse before we may cache this entry
 
202
            # again.  If we didn't do this, then, for example, a very quick 1
 
203
            # byte replacement in the file might go undetected.
 
204
            ## mutter('%r modified too recently; not caching', path)
 
205
            self.danger_count += 1
 
206
            if cache_fp:
 
207
                self.removed_count += 1
 
208
                self.needs_write = True
 
209
                del self._cache[path]
 
210
        else:
 
211
            ## mutter('%r added to cache: now=%f, mtime=%d, ctime=%d',
 
212
            ##        path, time.time(), file_fp[FP_MTIME_COLUMN],
 
213
            ##        file_fp[FP_CTIME_COLUMN])
 
214
            self.update_count += 1
 
215
            self.needs_write = True
 
216
            self._cache[path] = (digest, file_fp)
 
217
        return digest
 
218
 
 
219
    def _really_sha1_file(self, abspath, filters):
 
220
        """Calculate the SHA1 of a file by reading the full text"""
 
221
        return _mod_filters.internal_size_sha_file_byname(abspath, filters)[1]
 
222
 
 
223
    def write(self):
 
224
        """Write contents of cache to file."""
 
225
        outf = atomicfile.AtomicFile(self.cache_file_name(), 'wb',
 
226
                                     new_mode=self._mode)
 
227
        try:
 
228
            outf.write(CACHE_HEADER)
 
229
 
 
230
            for path, c  in self._cache.iteritems():
 
231
                line_info = [path.encode('utf-8'), '// ', c[0], ' ']
 
232
                line_info.append(' '.join([str(fld) for fld in c[1]]))
 
233
                line_info.append('\n')
 
234
                outf.write(''.join(line_info))
 
235
            outf.commit()
 
236
            self.needs_write = False
 
237
            ## mutter("write hash cache: %s hits=%d misses=%d stat=%d recent=%d updates=%d",
 
238
            ##        self.cache_file_name(), self.hit_count, self.miss_count,
 
239
            ##        self.stat_count,
 
240
            ##        self.danger_count, self.update_count)
 
241
        finally:
 
242
            outf.close()
 
243
 
 
244
    def read(self):
 
245
        """Reinstate cache from file.
 
246
 
 
247
        Overwrites existing cache.
 
248
 
 
249
        If the cache file has the wrong version marker, this just clears
 
250
        the cache."""
 
251
        self._cache = {}
 
252
 
 
253
        fn = self.cache_file_name()
 
254
        try:
 
255
            inf = file(fn, 'rb', buffering=65000)
 
256
        except IOError, e:
 
257
            trace.mutter("failed to open %s: %s", fn, e)
 
258
            # better write it now so it is valid
 
259
            self.needs_write = True
 
260
            return
 
261
 
 
262
        hdr = inf.readline()
 
263
        if hdr != CACHE_HEADER:
 
264
            trace.mutter('cache header marker not found at top of %s;'
 
265
                         ' discarding cache', fn)
 
266
            self.needs_write = True
 
267
            return
 
268
 
 
269
        for l in inf:
 
270
            pos = l.index('// ')
 
271
            path = l[:pos].decode('utf-8')
 
272
            if path in self._cache:
 
273
                trace.warning('duplicated path %r in cache' % path)
 
274
                continue
 
275
 
 
276
            pos += 3
 
277
            fields = l[pos:].split(' ')
 
278
            if len(fields) != 7:
 
279
                trace.warning("bad line in hashcache: %r" % l)
 
280
                continue
 
281
 
 
282
            sha1 = fields[0]
 
283
            if len(sha1) != 40:
 
284
                trace.warning("bad sha1 in hashcache: %r" % sha1)
 
285
                continue
 
286
 
 
287
            fp = tuple(map(long, fields[1:]))
 
288
 
 
289
            self._cache[path] = (sha1, fp)
 
290
 
 
291
        self.needs_write = False
 
292
 
 
293
    def _cutoff_time(self):
 
294
        """Return cutoff time.
 
295
 
 
296
        Files modified more recently than this time are at risk of being
 
297
        undetectably modified and so can't be cached.
 
298
        """
 
299
        return int(time.time()) - 3
 
300
 
 
301
    def _fingerprint(self, abspath, stat_value=None):
 
302
        if stat_value is None:
 
303
            try:
 
304
                stat_value = os.lstat(abspath)
 
305
            except OSError:
 
306
                # might be missing, etc
 
307
                return None
 
308
        if stat.S_ISDIR(stat_value.st_mode):
 
309
            return None
 
310
        # we discard any high precision because it's not reliable; perhaps we
 
311
        # could do better on some systems?
 
312
        return (stat_value.st_size, long(stat_value.st_mtime),
 
313
                long(stat_value.st_ctime), stat_value.st_ino,
 
314
                stat_value.st_dev, stat_value.st_mode)