1
# Copyright (C) 2006, 2008, 2009 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
"""Wrapper for readdir which returns files ordered by inode."""
24
cdef extern from "python-compat.h":
28
cdef extern from 'errno.h':
33
char *strerror(int errno)
34
# not necessarily a real variable, but this should be close enough
37
cdef extern from 'unistd.h':
41
char *getcwd(char *, int size)
43
cdef extern from 'stdlib.h':
48
cdef extern from 'sys/types.h':
50
ctypedef unsigned long size_t
52
ctypedef unsigned long ino_t
53
ctypedef unsigned long long off_t
57
cdef extern from 'sys/stat.h':
65
int lstat(char *path, stat *buf)
70
int S_ISFIFO(int mode)
72
int S_ISSOCK(int mode)
75
cdef extern from 'fcntl.h':
77
int open(char *pathname, int flags, mode_t mode)
80
cdef extern from 'Python.h':
81
int PyErr_CheckSignals() except -1
82
char * PyString_AS_STRING(object)
83
ctypedef int Py_ssize_t # Required for older pyrex versions
84
ctypedef struct PyObject:
86
Py_ssize_t PyString_Size(object s)
87
object PyList_GetItem(object lst, Py_ssize_t index)
88
void *PyList_GetItem_object_void "PyList_GET_ITEM" (object lst, int index)
89
int PyList_Append(object lst, object item) except -1
90
void *PyTuple_GetItem_void_void "PyTuple_GET_ITEM" (void* tpl, int index)
91
int PyTuple_SetItem(void *, Py_ssize_t pos, object item) except -1
92
int PyTuple_SetItem_obj "PyTuple_SetItem" (void *, Py_ssize_t pos, PyObject * item) except -1
93
void Py_INCREF(object o)
94
void Py_DECREF(object o)
95
void PyString_Concat(PyObject **string, object newpart)
98
cdef extern from 'dirent.h':
99
ctypedef struct dirent:
102
# the opaque C library DIR type.
104
# should be DIR *, pyrex barfs.
105
DIR * opendir(char * name)
106
int closedir(DIR * dir)
107
dirent *readdir(DIR *dir)
109
_directory = 'directory'
119
# add a typedef struct dirent dirent to workaround pyrex
120
cdef extern from 'readdir.h':
125
"""Represent a 'stat' result."""
131
return self._st.st_dev
135
return self._st.st_ino
139
return self._st.st_mode
143
return self._st.st_ctime
147
return self._st.st_mtime
151
return self._st.st_size
154
"""Repr is the same as a Stat object.
156
(mode, ino, dev, nlink, uid, gid, size, None(atime), mtime, ctime)
158
return repr((self.st_mode, 0, 0, 0, 0, 0, self.st_size, None,
159
self.st_mtime, self.st_ctime))
162
from bzrlib import osutils
165
cdef class UTF8DirReader:
166
"""A dir reader for utf8 file systems."""
168
cdef readonly object _safe_utf8
169
cdef _directory, _chardev, _block, _file, _fifo, _symlink
170
cdef _socket, _unknown
173
self._safe_utf8 = osutils.safe_utf8
174
self._directory = _directory
175
self._chardev = _chardev
179
self._symlink = _symlink
180
self._socket = _socket
181
self._unknown = _unknown
183
def kind_from_mode(self, int mode):
184
"""Get the kind of a path from a mode status."""
185
return self._kind_from_mode(mode)
187
cdef _kind_from_mode(self, int mode):
188
# Files and directories are the most common - check them first.
192
return self._directory
205
def top_prefix_to_starting_dir(self, top, prefix=""):
206
"""See DirReader.top_prefix_to_starting_dir."""
207
return (self._safe_utf8(prefix), None, None, None,
208
self._safe_utf8(top))
210
def read_dir(self, prefix, top):
211
"""Read a single directory from a utf8 file system.
213
All paths in and out are utf8.
215
This sub-function is called when we know the filesystem is already in utf8
216
encoding. So we don't need to transcode filenames.
218
See DirReader.read_dir for details.
220
#cdef char *_prefix = prefix
221
#cdef char *_top = top
222
# Use C accelerated directory listing.
228
cdef PyObject * new_val_obj
230
if PyString_Size(prefix):
231
relprefix = prefix + '/'
234
top_slash = top + '/'
236
# read_dir supplies in should-stat order.
237
# for _, name in sorted(_listdir(top)):
238
result = _read_dir(top)
241
for index from 0 <= index < length:
242
atuple = PyList_GetItem_object_void(result, index)
243
name = <object>PyTuple_GetItem_void_void(atuple, 1)
244
# We have a tuple with (inode, name, None, statvalue, None)
246
# inode -> path_from_top
247
# direct concat - faster than operator +.
248
new_val_obj = <PyObject *>relprefix
250
PyString_Concat(&new_val_obj, name)
251
if NULL == new_val_obj:
252
# PyString_Concat will have setup an exception, but how to get
254
raise Exception("failed to strcat")
255
PyTuple_SetItem_obj(atuple, 0, new_val_obj)
257
newval = self._kind_from_mode(
258
(<_Stat>PyTuple_GetItem_void_void(atuple, 3)).st_mode)
260
PyTuple_SetItem(atuple, 2, newval)
261
# 2nd None -> abspath # for all - the caller may need to stat files
263
# direct concat - faster than operator +.
264
new_val_obj = <PyObject *>top_slash
266
PyString_Concat(&new_val_obj, name)
267
if NULL == new_val_obj:
268
# PyString_Concat will have setup an exception, but how to get
270
raise Exception("failed to strcat")
271
PyTuple_SetItem_obj(atuple, 4, new_val_obj)
275
cdef raise_os_error(int errnum, char *msg_prefix, path):
278
raise OSError(errnum, msg_prefix + strerror(errnum), path)
281
cdef _read_dir(path):
282
"""Like os.listdir, this reads the contents of a directory.
284
:param path: the directory to list.
285
:return: a list of single-owner (the list) tuples ready for editing into
286
the result tuples walkdirs needs to yield. They contain (inode, name,
287
None, statvalue, None).
290
# currently this needs a fixup - the C code says 'dirent' but should say
300
# Avoid chdir('') because it causes problems on Sun OS, and avoid this if
302
if path != "" and path != '.':
303
# we change into the requested directory before reading, and back at the
304
# end, because that turns out to make the stat calls measurably faster than
305
# passing full paths every time.
306
orig_dir_fd = open(".", O_RDONLY, 0)
307
if orig_dir_fd == -1:
308
raise_os_error(errno, "open: ", ".")
309
if -1 == chdir(path):
310
raise_os_error(errno, "chdir: ", path)
315
the_dir = opendir(".")
317
raise_os_error(errno, "opendir: ", path)
322
# Unlike most libc functions, readdir needs errno set to 0
323
# beforehand so that eof can be distinguished from errors. See
324
# <https://bugs.launchpad.net/bzr/+bug/279381>
327
entry = readdir(the_dir)
328
if entry == NULL and (errno == EAGAIN or errno == EINTR):
336
if errno == ENOTDIR or errno == 0:
337
# We see ENOTDIR at the end of a normal directory.
338
# As ENOTDIR for read_dir(file) is triggered on opendir,
339
# we consider ENOTDIR to be 'no error'.
342
raise_os_error(errno, "readdir: ", path)
344
if not (name[0] == c"." and (
346
(name[1] == c"." and name[2] == 0))
349
stat_result = lstat(entry.d_name, &statvalue._st)
352
raise_os_error(errno, "lstat: ",
353
path + "/" + entry.d_name)
355
# the file seems to have disappeared after being
356
# seen by readdir - perhaps a transient temporary
357
# file. there's no point returning it.
359
# We append a 5-tuple that can be modified in-place by the C
361
# inode to sort on (to replace with top_path)
363
# kind (None, to set)
364
# statvalue (to keep)
365
# abspath (None, to set)
366
PyList_Append(result, (entry.d_ino, entry.d_name, None,
369
if -1 == closedir(the_dir):
370
raise_os_error(errno, "closedir: ", path)
372
if -1 != orig_dir_fd:
374
if -1 == fchdir(orig_dir_fd):
375
# try to close the original directory anyhow
377
if -1 == close(orig_dir_fd) or failed:
378
raise_os_error(errno, "return to orig_dir: ", "")
383
# vim: tw=79 ai expandtab sw=4 sts=4