/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 breezy/_readdir_pyx.pyx

  • Committer: Jelmer Vernooij
  • Date: 2020-05-24 00:39:50 UTC
  • mto: This revision was merged to the branch mainline in revision 7504.
  • Revision ID: jelmer@jelmer.uk-20200524003950-bbc545r76vc5yajg
Add github action.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/_readdir_pyx.pyx
 
1
# Copyright (C) 2006, 2008, 2009, 2010 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
"""Wrapper for readdir which returns files ordered by inode."""
 
18
 
 
19
 
 
20
import os
 
21
import sys
 
22
 
 
23
cdef extern from "python-compat.h":
 
24
    pass
 
25
 
 
26
 
 
27
cdef extern from 'errno.h':
 
28
    int ENOENT
 
29
    int ENOTDIR
 
30
    int EAGAIN
 
31
    int EINTR
 
32
    char *strerror(int errno)
 
33
    # not necessarily a real variable, but this should be close enough
 
34
    int errno
 
35
 
 
36
cdef extern from 'unistd.h':
 
37
    int chdir(char *path)
 
38
    int close(int fd)
 
39
    int fchdir(int fd)
 
40
    char *getcwd(char *, int size)
 
41
 
 
42
cdef extern from 'stdlib.h':
 
43
    void *malloc(int)
 
44
    void free(void *)
 
45
 
 
46
 
 
47
cdef extern from 'sys/types.h':
 
48
    ctypedef long ssize_t
 
49
    ctypedef unsigned long size_t
 
50
    ctypedef long time_t
 
51
    ctypedef unsigned long ino_t
 
52
    ctypedef unsigned long long off_t
 
53
    ctypedef int mode_t
 
54
 
 
55
 
 
56
cdef extern from 'sys/stat.h':
 
57
    cdef struct stat:
 
58
        int st_mode
 
59
        off_t st_size
 
60
        int st_dev
 
61
        ino_t st_ino
 
62
        int st_mtime
 
63
        int st_ctime
 
64
    int lstat(char *path, stat *buf)
 
65
    int S_ISDIR(int mode)
 
66
    int S_ISCHR(int mode)
 
67
    int S_ISBLK(int mode)
 
68
    int S_ISREG(int mode)
 
69
    int S_ISFIFO(int mode)
 
70
    int S_ISLNK(int mode)
 
71
    int S_ISSOCK(int mode)
 
72
 
 
73
 
 
74
cdef extern from 'fcntl.h':
 
75
    int O_RDONLY
 
76
    int open(char *pathname, int flags, mode_t mode)
 
77
 
 
78
 
 
79
cdef extern from 'Python.h':
 
80
    int PyErr_CheckSignals() except -1
 
81
    char * PyBytes_AS_STRING(object)
 
82
    ctypedef struct PyObject:
 
83
        pass
 
84
    Py_ssize_t PyBytes_Size(object s)
 
85
    object PyList_GetItem(object lst, Py_ssize_t index)
 
86
    void *PyList_GetItem_object_void "PyList_GET_ITEM" (object lst, int index)
 
87
    int PyList_Append(object lst, object item) except -1
 
88
    void *PyTuple_GetItem_void_void "PyTuple_GET_ITEM" (void* tpl, int index)
 
89
    int PyTuple_SetItem(void *, Py_ssize_t pos, object item) except -1
 
90
    int PyTuple_SetItem_obj "PyTuple_SetItem" (void *, Py_ssize_t pos, PyObject * item) except -1
 
91
    void Py_INCREF(object o)
 
92
    void Py_DECREF(object o)
 
93
    void PyBytes_Concat(PyObject **string, object newpart)
 
94
 
 
95
 
 
96
cdef extern from 'dirent.h':
 
97
    ctypedef struct dirent:
 
98
        char d_name[256]
 
99
        ino_t d_ino
 
100
    # the opaque C library DIR type.
 
101
    ctypedef struct DIR
 
102
    # should be DIR *, pyrex barfs.
 
103
    DIR * opendir(char * name)
 
104
    int closedir(DIR * dir)
 
105
    dirent *readdir(DIR *dir)
 
106
 
 
107
cdef object _directory
 
108
_directory = 'directory'
 
109
cdef object _chardev
 
110
_chardev = 'chardev'
 
111
cdef object _block
 
112
_block = 'block'
 
113
cdef object _file
 
114
_file = 'file'
 
115
cdef object _fifo
 
116
_fifo = 'fifo'
 
117
cdef object _symlink
 
118
_symlink = 'symlink'
 
119
cdef object _socket
 
120
_socket = 'socket'
 
121
cdef object _unknown
 
122
_unknown = 'unknown'
 
123
 
 
124
# add a typedef struct dirent dirent to workaround pyrex
 
125
cdef extern from 'readdir.h':
 
126
    pass
 
127
 
 
128
 
 
129
cdef class _Stat:
 
130
    """Represent a 'stat' result."""
 
131
 
 
132
    cdef stat _st
 
133
 
 
134
    property st_dev:
 
135
        def __get__(self):
 
136
            return self._st.st_dev
 
137
 
 
138
    property st_ino:
 
139
        def __get__(self):
 
140
            return self._st.st_ino
 
141
 
 
142
    property st_mode:
 
143
        def __get__(self):
 
144
            return self._st.st_mode
 
145
 
 
146
    property st_ctime:
 
147
        def __get__(self):
 
148
            return self._st.st_ctime
 
149
 
 
150
    property st_mtime:
 
151
        def __get__(self):
 
152
            return self._st.st_mtime
 
153
 
 
154
    property st_size:
 
155
        def __get__(self):
 
156
            return self._st.st_size
 
157
 
 
158
    def __repr__(self):
 
159
        """Repr is the same as a Stat object.
 
160
 
 
161
        (mode, ino, dev, nlink, uid, gid, size, None(atime), mtime, ctime)
 
162
        """
 
163
        return repr((self.st_mode, 0, 0, 0, 0, 0, self.st_size, None,
 
164
                     self.st_mtime, self.st_ctime))
 
165
 
 
166
 
 
167
from . import osutils
 
168
 
 
169
cdef object _safe_utf8
 
170
_safe_utf8 = osutils.safe_utf8
 
171
 
 
172
cdef class UTF8DirReader:
 
173
    """A dir reader for utf8 file systems."""
 
174
 
 
175
    def kind_from_mode(self, int mode):
 
176
        """Get the kind of a path from a mode status."""
 
177
        return self._kind_from_mode(mode)
 
178
 
 
179
    cdef _kind_from_mode(self, int mode):
 
180
        # Files and directories are the most common - check them first.
 
181
        if S_ISREG(mode):
 
182
            return _file
 
183
        if S_ISDIR(mode):
 
184
            return _directory
 
185
        if S_ISCHR(mode):
 
186
            return _chardev
 
187
        if S_ISBLK(mode):
 
188
            return _block
 
189
        if S_ISLNK(mode):
 
190
            return _symlink
 
191
        if S_ISFIFO(mode):
 
192
            return _fifo
 
193
        if S_ISSOCK(mode):
 
194
            return _socket
 
195
        return _unknown
 
196
 
 
197
    def top_prefix_to_starting_dir(self, top, prefix=""):
 
198
        """See DirReader.top_prefix_to_starting_dir."""
 
199
        return (_safe_utf8(prefix), None, None, None, _safe_utf8(top))
 
200
 
 
201
    def read_dir(self, prefix, top):
 
202
        """Read a single directory from a utf8 file system.
 
203
 
 
204
        All paths in and out are utf8.
 
205
 
 
206
        This sub-function is called when we know the filesystem is already in utf8
 
207
        encoding. So we don't need to transcode filenames.
 
208
 
 
209
        See DirReader.read_dir for details.
 
210
        """
 
211
        #cdef char *_prefix = prefix
 
212
        #cdef char *_top = top
 
213
        # Use C accelerated directory listing.
 
214
        cdef object newval
 
215
        cdef int index
 
216
        cdef int length
 
217
        cdef void * atuple
 
218
        cdef object name
 
219
        cdef PyObject * new_val_obj
 
220
 
 
221
        if PyBytes_Size(prefix):
 
222
            relprefix = prefix + b'/'
 
223
        else:
 
224
            relprefix = b''
 
225
        top_slash = top + b'/'
 
226
 
 
227
        # read_dir supplies in should-stat order.
 
228
        # for _, name in sorted(_listdir(top)):
 
229
        result = _read_dir(top)
 
230
        length = len(result)
 
231
        # result.sort()
 
232
        for index from 0 <= index < length:
 
233
            atuple = PyList_GetItem_object_void(result, index)
 
234
            name = <object>PyTuple_GetItem_void_void(atuple, 1)
 
235
            # We have a tuple with (inode, name, None, statvalue, None)
 
236
            # Now edit it:
 
237
            # inode -> path_from_top
 
238
            # direct concat - faster than operator +.
 
239
            new_val_obj = <PyObject *>relprefix
 
240
            Py_INCREF(relprefix)
 
241
            PyBytes_Concat(&new_val_obj, name)
 
242
            if NULL == new_val_obj:
 
243
                # PyBytes_Concat will have setup an exception, but how to get
 
244
                # at it?
 
245
                raise Exception("failed to strcat")
 
246
            PyTuple_SetItem_obj(atuple, 0, new_val_obj)
 
247
            # 1st None -> kind
 
248
            newval = self._kind_from_mode(
 
249
                (<_Stat>PyTuple_GetItem_void_void(atuple, 3)).st_mode)
 
250
            Py_INCREF(newval)
 
251
            PyTuple_SetItem(atuple, 2, newval)
 
252
            # 2nd None -> abspath # for all - the caller may need to stat files
 
253
            # etc.
 
254
            # direct concat - faster than operator +.
 
255
            new_val_obj = <PyObject *>top_slash
 
256
            Py_INCREF(top_slash)
 
257
            PyBytes_Concat(&new_val_obj, name)
 
258
            if NULL == new_val_obj:
 
259
                # PyBytes_Concat will have setup an exception, but how to get
 
260
                # at it?
 
261
                raise Exception("failed to strcat")
 
262
            PyTuple_SetItem_obj(atuple, 4, new_val_obj)
 
263
        return result
 
264
 
 
265
 
 
266
cdef raise_os_error(int errnum, char *msg_prefix, path):
 
267
    if errnum == EINTR:
 
268
        PyErr_CheckSignals()
 
269
    raise OSError(errnum, msg_prefix + strerror(errnum), path)
 
270
 
 
271
 
 
272
cdef _read_dir(path):
 
273
    """Like os.listdir, this reads the contents of a directory.
 
274
 
 
275
    :param path: the directory to list.
 
276
    :return: a list of single-owner (the list) tuples ready for editing into
 
277
        the result tuples walkdirs needs to yield. They contain (inode, name,
 
278
        None, statvalue, None).
 
279
    """
 
280
    cdef DIR *the_dir
 
281
    # currently this needs a fixup - the C code says 'dirent' but should say
 
282
    # 'struct dirent'
 
283
    cdef dirent * entry
 
284
    cdef dirent sentinel
 
285
    cdef char *name
 
286
    cdef int stat_result
 
287
    cdef _Stat statvalue
 
288
    global errno
 
289
    cdef int orig_dir_fd
 
290
 
 
291
    # Avoid chdir('') because it causes problems on Sun OS, and avoid this if
 
292
    # staying in .
 
293
    if path != b"" and path != b'.':
 
294
        # we change into the requested directory before reading, and back at the
 
295
        # end, because that turns out to make the stat calls measurably faster than
 
296
        # passing full paths every time.
 
297
        orig_dir_fd = open(".", O_RDONLY, 0)
 
298
        if orig_dir_fd == -1:
 
299
            raise_os_error(errno, "open: ", ".")
 
300
        if -1 == chdir(path):
 
301
            # Ignore the return value, because we are already raising an
 
302
            # exception
 
303
            close(orig_dir_fd)
 
304
            raise_os_error(errno, "chdir: ", path)
 
305
    else:
 
306
        orig_dir_fd = -1
 
307
 
 
308
    try:
 
309
        the_dir = opendir(b".")
 
310
        if NULL == the_dir:
 
311
            raise_os_error(errno, "opendir: ", path)
 
312
        try:
 
313
            result = []
 
314
            entry = &sentinel
 
315
            while entry != NULL:
 
316
                # Unlike most libc functions, readdir needs errno set to 0
 
317
                # beforehand so that eof can be distinguished from errors.  See
 
318
                # <https://bugs.launchpad.net/bzr/+bug/279381>
 
319
                while True:
 
320
                    errno = 0
 
321
                    entry = readdir(the_dir)
 
322
                    if entry == NULL and (errno == EAGAIN or errno == EINTR):
 
323
                        if errno == EINTR:
 
324
                            PyErr_CheckSignals()
 
325
                        # try again
 
326
                        continue
 
327
                    else:
 
328
                        break
 
329
                if entry == NULL:
 
330
                    if errno == ENOTDIR or errno == 0:
 
331
                        # We see ENOTDIR at the end of a normal directory.
 
332
                        # As ENOTDIR for read_dir(file) is triggered on opendir,
 
333
                        # we consider ENOTDIR to be 'no error'.
 
334
                        continue
 
335
                    else:
 
336
                        raise_os_error(errno, "readdir: ", path)
 
337
                name = entry.d_name
 
338
                if not (name[0] == c"." and (
 
339
                    (name[1] == 0) or 
 
340
                    (name[1] == c"." and name[2] == 0))
 
341
                    ):
 
342
                    statvalue = _Stat()
 
343
                    stat_result = lstat(entry.d_name, &statvalue._st)
 
344
                    if stat_result != 0:
 
345
                        if errno != ENOENT:
 
346
                            raise_os_error(errno, "lstat: ",
 
347
                                path + b"/" + entry.d_name)
 
348
                        else:
 
349
                            # the file seems to have disappeared after being
 
350
                            # seen by readdir - perhaps a transient temporary
 
351
                            # file.  there's no point returning it.
 
352
                            continue
 
353
                    # We append a 5-tuple that can be modified in-place by the C
 
354
                    # api:
 
355
                    # inode to sort on (to replace with top_path)
 
356
                    # name (to keep)
 
357
                    # kind (None, to set)
 
358
                    # statvalue (to keep)
 
359
                    # abspath (None, to set)
 
360
                    PyList_Append(result, (entry.d_ino, entry.d_name, None,
 
361
                        statvalue, None))
 
362
        finally:
 
363
            if -1 == closedir(the_dir):
 
364
                raise_os_error(errno, "closedir: ", path)
 
365
    finally:
 
366
        if -1 != orig_dir_fd:
 
367
            failed = False
 
368
            if -1 == fchdir(orig_dir_fd):
 
369
                # try to close the original directory anyhow
 
370
                failed = True
 
371
            if -1 == close(orig_dir_fd) or failed:
 
372
                raise_os_error(errno, "return to orig_dir: ", "")
 
373
 
 
374
    return result
 
375
 
 
376
 
 
377
# vim: tw=79 ai expandtab sw=4 sts=4