← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/_walkdirs_win32.pyx

(vila) Fix test failures blocking package builds. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/_walkdirs_win32.pyx
1
 
# Copyright (C) 2008 Canonical Ltd
 
1
# Copyright (C) 2008-2012 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
17
"""Helper functions for Walkdirs on win32."""
18
18
 
19
19
 
20
 
cdef extern from "_walkdirs_win32.h":
 
20
cdef extern from "python-compat.h":
21
21
    struct _HANDLE:
22
22
        pass
23
23
    ctypedef _HANDLE *HANDLE
69
69
 
70
70
 
71
71
import operator
 
72
import os
72
73
import stat
73
74
 
74
 
from bzrlib import osutils
 
75
from bzrlib import _readdir_py
 
76
 
 
77
cdef object osutils
 
78
osutils = None
75
79
 
76
80
 
77
81
cdef class _Win32Stat:
81
85
    cdef readonly double st_ctime
82
86
    cdef readonly double st_mtime
83
87
    cdef readonly double st_atime
84
 
    cdef readonly __int64 st_size
 
88
    # We can't just declare this as 'readonly' because python2.4 doesn't define
 
89
    # T_LONGLONG as a structure member. So instead we just use a property that
 
90
    # will convert it correctly anyway.
 
91
    cdef __int64 _st_size
 
92
 
 
93
    property st_size:
 
94
        def __get__(self):
 
95
            return self._st_size
85
96
 
86
97
    # os.stat always returns 0, so we hard code it here
87
 
    cdef readonly int st_dev
88
 
    cdef readonly int st_ino
 
98
    property st_dev:
 
99
        def __get__(self):
 
100
            return 0
 
101
    property st_ino:
 
102
        def __get__(self):
 
103
            return 0
 
104
    # st_uid and st_gid required for some external tools like bzr-git & dulwich
 
105
    property st_uid:
 
106
        def __get__(self):
 
107
            return 0
 
108
    property st_gid:
 
109
        def __get__(self):
 
110
            return 0
89
111
 
90
112
    def __repr__(self):
91
113
        """Repr is the same as a Stat object.
102
124
                                 wcslen(data.cFileName))
103
125
 
104
126
 
105
 
cdef int _get_mode_bits(WIN32_FIND_DATAW *data):
 
127
cdef int _get_mode_bits(WIN32_FIND_DATAW *data): # cannot_raise
106
128
    cdef int mode_bits
107
129
 
108
130
    mode_bits = 0100666 # writeable file, the most common
114
136
    return mode_bits
115
137
 
116
138
 
117
 
cdef __int64 _get_size(WIN32_FIND_DATAW *data):
 
139
cdef __int64 _get_size(WIN32_FIND_DATAW *data): # cannot_raise
118
140
    # Pyrex casts a DWORD into a PyLong anyway, so it is safe to do << 32
119
141
    # on a DWORD
120
142
    return ((<__int64>data.nFileSizeHigh) << 32) + data.nFileSizeLow
121
143
 
122
144
 
123
 
cdef double _ftime_to_timestamp(FILETIME *ft):
 
145
cdef double _ftime_to_timestamp(FILETIME *ft): # cannot_raise
124
146
    """Convert from a FILETIME struct into a floating point timestamp.
125
147
 
126
148
    The fields of a FILETIME structure are the hi and lo part
140
162
    return (val * 1.0e-7) - 11644473600.0
141
163
 
142
164
 
143
 
cdef int _should_skip(WIN32_FIND_DATAW *data):
 
165
cdef int _should_skip(WIN32_FIND_DATAW *data): # cannot_raise
144
166
    """Is this '.' or '..' so we should skip it?"""
145
167
    if (data.cFileName[0] != c'.'):
146
168
        return 0
151
173
    return 0
152
174
 
153
175
 
154
 
cdef class Win32Finder:
155
 
    """A class which encapsulates the search of files in a given directory"""
156
 
 
157
 
    cdef object _top
158
 
    cdef object _prefix
 
176
cdef class Win32ReadDir:
 
177
    """Read directories on win32."""
159
178
 
160
179
    cdef object _directory_kind
161
180
    cdef object _file_kind
162
181
 
163
 
    cdef object _pending
164
 
    cdef object _last_dirblock
165
 
 
166
 
    def __init__(self, top, prefix=""):
167
 
        self._top = top
168
 
        self._prefix = prefix
169
 
 
170
 
        self._directory_kind = osutils._directory_kind
171
 
        self._file_kind = osutils._formats[stat.S_IFREG]
172
 
 
173
 
        self._pending = [(osutils.safe_utf8(prefix), osutils.safe_unicode(top))]
174
 
        self._last_dirblock = None
175
 
 
176
 
    def __iter__(self):
177
 
        return self
 
182
    def __init__(self):
 
183
        self._directory_kind = _readdir_py._directory
 
184
        self._file_kind = _readdir_py._file
 
185
 
 
186
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
187
        """See DirReader.top_prefix_to_starting_dir."""
 
188
        global osutils
 
189
        if osutils is None:
 
190
            from bzrlib import osutils
 
191
        return (osutils.safe_utf8(prefix), None, None, None,
 
192
                osutils.safe_unicode(top))
178
193
 
179
194
    cdef object _get_kind(self, WIN32_FIND_DATAW *data):
180
195
        if data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY:
190
205
        statvalue.st_ctime = _ftime_to_timestamp(&data.ftCreationTime)
191
206
        statvalue.st_mtime = _ftime_to_timestamp(&data.ftLastWriteTime)
192
207
        statvalue.st_atime = _ftime_to_timestamp(&data.ftLastAccessTime)
193
 
        statvalue.st_size = _get_size(data)
194
 
        statvalue.st_ino = 0
195
 
        statvalue.st_dev = 0
 
208
        statvalue._st_size = _get_size(data)
196
209
        return statvalue
197
210
 
198
 
    def _get_files_in(self, directory, relprefix):
199
 
        """Return the dirblock for all files in the given directory.
 
211
    def read_dir(self, prefix, top):
 
212
        """Win32 implementation of DirReader.read_dir.
200
213
 
201
 
        :param directory: A path that can directly access the files on disk.
202
 
            Should be a Unicode object.
203
 
        :param relprefix: A psuedo path for these files (as inherited from the
204
 
            original 'prefix=XXX' when instantiating this class.)
205
 
            It should be a UTF-8 string.
206
 
        :return: A dirblock for all the files of the form
207
 
            [(utf8_relpath, utf8_fname, kind, _Win32Stat, unicode_abspath)]
 
214
        :seealso: DirReader.read_dir
208
215
        """
209
216
        cdef WIN32_FIND_DATAW search_data
210
217
        cdef HANDLE hFindFile
212
219
        cdef WCHAR *query
213
220
        cdef int result
214
221
 
215
 
        top_star = directory + '*'
 
222
        if prefix:
 
223
            relprefix = prefix + '/'
 
224
        else:
 
225
            relprefix = ''
 
226
        top_slash = top + '/'
 
227
 
 
228
        top_star = top_slash + '*'
216
229
 
217
230
        dirblock = []
218
231
 
231
244
                    continue
232
245
                name_unicode = _get_name(&search_data)
233
246
                name_utf8 = PyUnicode_AsUTF8String(name_unicode)
234
 
                PyList_Append(dirblock, 
235
 
                    (relprefix + name_utf8, name_utf8, 
 
247
                PyList_Append(dirblock,
 
248
                    (relprefix + name_utf8, name_utf8,
236
249
                     self._get_kind(&search_data),
237
250
                     self._get_stat_value(&search_data),
238
 
                     directory + name_unicode))
 
251
                     top_slash + name_unicode))
239
252
 
240
253
                result = FindNextFileW(hFindFile, &search_data)
241
254
            # FindNextFileW sets GetLastError() == ERROR_NO_MORE_FILES when it
251
264
                # TODO: We should probably raise an exception if FindClose
252
265
                #       returns an error, however, I don't want to supress an
253
266
                #       earlier Exception, so for now, I'm ignoring this
 
267
        dirblock.sort(key=operator.itemgetter(1))
254
268
        return dirblock
255
269
 
256
 
    cdef _update_pending(self):
257
 
        """If we had a result before, add the subdirs to pending."""
258
 
        if self._last_dirblock is not None:
259
 
            # push the entries left in the dirblock onto the pending queue
260
 
            # we do this here, because we allow the user to modified the
261
 
            # queue before the next iteration
262
 
            for d in reversed(self._last_dirblock):
263
 
                if d[2] == self._directory_kind:
264
 
                    self._pending.append((d[0], d[-1]))
265
 
            self._last_dirblock = None
266
 
        
267
 
    def __next__(self):
268
 
        self._update_pending()
269
 
        if not self._pending:
270
 
            raise StopIteration()
271
 
        relroot, top = self._pending.pop()
272
 
        # NB: At the moment Pyrex doesn't support Unicode literals, which means
273
 
        # that all of these string literals are going to be upcasted to Unicode
274
 
        # at runtime... :(
275
 
        # Maybe we could use unicode(x) during __init__?
276
 
        if relroot:
277
 
            relprefix = relroot + '/'
278
 
        else:
279
 
            relprefix = ''
280
 
        top_slash = top + '/'
281
 
 
282
 
        dirblock = self._get_files_in(top_slash, relprefix)
283
 
        dirblock.sort(key=operator.itemgetter(1))
284
 
        self._last_dirblock = dirblock
285
 
        return (relroot, top), dirblock
286
 
 
287
 
 
288
 
def _walkdirs_utf8_win32_find_file(top, prefix=""):
289
 
    """Implement a version of walkdirs_utf8 for win32.
290
 
 
291
 
    This uses the find files api to both list the files and to stat them.
292
 
    """
293
 
    return Win32Finder(top, prefix=prefix)
 
270
 
 
271
def lstat(path):
 
272
    """Equivalent to os.lstat, except match Win32ReadDir._get_stat_value.
 
273
    """
 
274
    return wrap_stat(os.lstat(path))
 
275
 
 
276
 
 
277
def fstat(fd):
 
278
    """Like os.fstat, except match Win32ReadDir._get_stat_value
 
279
 
 
280
    :seealso: wrap_stat
 
281
    """
 
282
    return wrap_stat(os.fstat(fd))
 
283
 
 
284
 
 
285
def wrap_stat(st):
 
286
    """Return a _Win32Stat object, based on the given stat result.
 
287
 
 
288
    On Windows, os.fstat(open(fname).fileno()) != os.lstat(fname). This is
 
289
    generally because os.lstat and os.fstat differ in what they put into st_ino
 
290
    and st_dev. What gets set where seems to also be dependent on the python
 
291
    version. So we always set it to 0 to avoid worrying about it.
 
292
    """
 
293
    cdef _Win32Stat statvalue
 
294
    statvalue = _Win32Stat()
 
295
    statvalue.st_mode = st.st_mode
 
296
    statvalue.st_ctime = st.st_ctime
 
297
    statvalue.st_mtime = st.st_mtime
 
298
    statvalue.st_atime = st.st_atime
 
299
    statvalue._st_size = st.st_size
 
300
    return statvalue