1
# Copyright (C) 2006, 2008 Canonical Ltd
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.
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.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Wrapper for readdir which returns files ordered by inode."""
24
# the opaque C library DIR type.
25
cdef extern from 'errno.h':
30
char *strerror(int errno)
32
cdef extern from 'unistd.h':
34
char *getcwd(char *, int size)
36
cdef extern from 'stdlib.h':
40
cdef extern from 'sys/stat.h':
48
int lstat(char *path, stat *buf)
53
int S_ISFIFO(int mode)
55
int S_ISSOCK(int mode)
58
cdef extern from 'sys/types.h':
60
ctypedef unsigned long size_t
62
ctypedef unsigned long ino_t
65
cdef extern from 'Python.h':
66
char * PyString_AS_STRING(object)
67
ctypedef int Py_ssize_t # Required for older pyrex versions
68
ctypedef struct PyObject:
70
Py_ssize_t PyString_Size(object s)
71
object PyList_GetItem(object lst, Py_ssize_t index)
72
void *PyList_GetItem_object_void "PyList_GET_ITEM" (object lst, int index)
73
int PyList_Append(object lst, object item) except -1
74
void *PyTuple_GetItem_void_void "PyTuple_GET_ITEM" (void* tpl, int index)
75
int PyTuple_SetItem(void *, Py_ssize_t pos, object item) except -1
76
int PyTuple_SetItem_obj "PyTuple_SetItem" (void *, Py_ssize_t pos, PyObject * item) except -1
77
void Py_INCREF(object o)
78
void Py_DECREF(object o)
79
void PyString_Concat(PyObject **string, object newpart)
82
cdef extern from 'dirent.h':
83
ctypedef struct dirent:
87
# should be DIR *, pyrex barfs.
88
DIR * opendir(char * name)
89
int closedir(DIR * dir)
90
dirent *readdir(DIR *dir)
92
_directory = 'directory'
102
# add a typedef struct dirent dirent to workaround pyrex
103
cdef extern from 'readdir.h':
108
"""Represent a 'stat' result."""
114
return self._st.st_dev
118
return self._st.st_ino
122
return self._st.st_mode
126
return self._st.st_ctime
130
return self._st.st_mtime
134
return self._st.st_size
137
"""Repr is the same as a Stat object.
139
(mode, ino, dev, nlink, uid, gid, size, None(atime), mtime, ctime)
141
return repr((self.st_mode, 0, 0, 0, 0, 0, self.st_size, None,
142
self._mtime, self._ctime))
145
from bzrlib import osutils
148
cdef class UTF8DirReader:
149
"""A dir reader for utf8 file systems."""
151
cdef readonly object _safe_utf8
152
cdef _directory, _chardev, _block, _file, _fifo, _symlink
153
cdef _socket, _unknown
156
self._safe_utf8 = osutils.safe_utf8
157
self._directory = _directory
158
self._chardev = _chardev
162
self._symlink = _symlink
163
self._socket = _socket
164
self._unknown = _unknown
166
def kind_from_mode(self, int mode):
167
"""Get the kind of a path from a mode status."""
168
return self._kind_from_mode(mode)
170
cdef _kind_from_mode(self, int mode):
171
# in order of frequency:
175
return self._directory
188
def top_prefix_to_starting_dir(self, top, prefix=""):
189
"""See DirReader.top_prefix_to_starting_dir."""
190
return (self._safe_utf8(prefix), None, None, None,
191
self._safe_utf8(top))
193
def read_dir(self, prefix, top):
194
"""Read a single directory from a utf8 file system.
196
All paths in and out are utf8.
198
This sub-function is called when we know the filesystem is already in utf8
199
encoding. So we don't need to transcode filenames.
201
See DirReader.read_dir for details.
203
#cdef char *_prefix = prefix
204
#cdef char *_top = top
205
# Use C accelerated directory listing.
211
cdef PyObject * new_val_obj
213
if PyString_Size(prefix):
214
relprefix = prefix + '/'
217
top_slash = top + '/'
219
# read_dir supplies in should-stat order.
220
# for _, name in sorted(_listdir(top)):
221
result = _read_dir(top)
224
for index from 0 <= index < length:
225
atuple = PyList_GetItem_object_void(result, index)
226
name = <object>PyTuple_GetItem_void_void(atuple, 1)
227
# We have inode, name, None, statvalue, None
228
# inode -> path_from_top
229
# direct concat - faster than operator +.
230
new_val_obj = <PyObject *>relprefix
232
PyString_Concat(&new_val_obj, name)
233
if NULL == new_val_obj:
234
# PyString_Concat will have setup an exception, but how to get
236
raise Exception("failed to strcat")
237
PyTuple_SetItem_obj(atuple, 0, new_val_obj)
239
newval = self._kind_from_mode(
240
(<_Stat>PyTuple_GetItem_void_void(atuple, 3)).st_mode)
242
PyTuple_SetItem(atuple, 2, newval)
243
# none -> abspath # perhaps only do if its a dir?
244
# direct concat - faster than operator +.
245
new_val_obj = <PyObject *>top_slash
247
PyString_Concat(&new_val_obj, name)
248
if NULL == new_val_obj:
249
# PyString_Concat will have setup an exception, but how to get
251
raise Exception("failed to strcat")
252
PyTuple_SetItem_obj(atuple, 4, new_val_obj)
256
cdef _read_dir(path):
257
"""Like os.listdir, this reads the contents of a directory.
259
:param path: the directory to list.
260
:return: a list of (sort_key, basename) tuples.
263
# currently this needs a fixup - the C code says 'dirent' but should say
272
cwd = getcwd(NULL, 0)
273
if -1 == chdir(path):
274
raise OSError(errno, strerror(errno))
275
the_dir = opendir(".")
277
raise OSError(errno, strerror(errno))
282
entry = readdir(the_dir)
287
elif errno != ENOTDIR and errno != ENOENT and errno != 0:
288
# We see ENOTDIR at the end of a normal directory.
289
# As ENOTDIR for read_dir(file) is triggered on opendir,
290
# we consider ENOTDIR to be 'no error'.
291
# ENOENT is listed as 'invalid position in the dir stream' for
292
# readdir. We swallow this for now and just keep reading.
293
raise OSError(errno, strerror(errno))
298
if not (name[0] == c"." and (
300
(name[1] == c"." and name[2] == 0))
303
stat_result = lstat(entry.d_name, &statvalue._st)
306
raise OSError(errno, strerror(errno))
310
# We append a 5-tuple that can be modified in-place by the C
312
# inode to sort on (to replace with top_path)
314
# kind (None, to set)
315
# statvalue (to keep)
316
# abspath (None, to set)
317
PyList_Append(result, (entry.d_ino, entry.d_name, None,
322
raise OSError(errno, strerror(errno))
324
if -1 == closedir(the_dir):
325
raise OSError(errno, strerror(errno))
329
# vim: tw=79 ai expandtab sw=4 sts=4