~bzr-pqm/bzr/bzr.dev

# Copyright (C) 2008-2012 Canonical Ltd

#

# This program is free software; you can redistribute it and/or modify

# it under the terms of the GNU General Public License as published by

# the Free Software Foundation; either version 2 of the License, or

# (at your option) any later version.

#

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

#

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

"""Helper functions for Walkdirs on win32."""

cdef extern from "python-compat.h":

    struct _HANDLE:

        pass

    ctypedef _HANDLE *HANDLE

    ctypedef unsigned long DWORD

    ctypedef long long __int64

    ctypedef unsigned short WCHAR

    struct _FILETIME:

        DWORD dwHighDateTime

        DWORD dwLowDateTime

    ctypedef _FILETIME FILETIME

    struct _WIN32_FIND_DATAW:

        DWORD dwFileAttributes

        FILETIME ftCreationTime

        FILETIME ftLastAccessTime

        FILETIME ftLastWriteTime

        DWORD nFileSizeHigh

        DWORD nFileSizeLow

        # Some reserved stuff here

        WCHAR cFileName[260] # MAX_PATH

        WCHAR cAlternateFilename[14]

    # We have to use the typedef trick, otherwise pyrex uses:

    #  struct WIN32_FIND_DATAW

    # which fails due to 'incomplete type'

    ctypedef _WIN32_FIND_DATAW WIN32_FIND_DATAW

    HANDLE INVALID_HANDLE_VALUE

    HANDLE FindFirstFileW(WCHAR *path, WIN32_FIND_DATAW *data)

    int FindNextFileW(HANDLE search, WIN32_FIND_DATAW *data)

    int FindClose(HANDLE search)

    DWORD FILE_ATTRIBUTE_READONLY

    DWORD FILE_ATTRIBUTE_DIRECTORY

    int ERROR_NO_MORE_FILES

    int GetLastError()

    # Wide character functions

    DWORD wcslen(WCHAR *)

cdef extern from "Python.h":

    WCHAR *PyUnicode_AS_UNICODE(object)

    Py_ssize_t PyUnicode_GET_SIZE(object)

    object PyUnicode_FromUnicode(WCHAR *, Py_ssize_t)

    int PyList_Append(object, object) except -1

    object PyUnicode_AsUTF8String(object)

import operator

import os

import stat

from bzrlib import _readdir_py

cdef object osutils

osutils = None

cdef class _Win32Stat:

    """Represent a 'stat' result generated from WIN32_FIND_DATA"""

    cdef readonly int st_mode

    cdef readonly double st_ctime

    cdef readonly double st_mtime

    cdef readonly double st_atime

    # We can't just declare this as 'readonly' because python2.4 doesn't define

    # T_LONGLONG as a structure member. So instead we just use a property that

    # will convert it correctly anyway.

    cdef __int64 _st_size

    property st_size:

        def __get__(self):

            return self._st_size

    # os.stat always returns 0, so we hard code it here

    property st_dev:

        def __get__(self):

            return 0

    property st_ino:

        def __get__(self):

            return 0

    # st_uid and st_gid required for some external tools like bzr-git & dulwich

    property st_uid:

        def __get__(self):

            return 0

    property st_gid:

        def __get__(self):

            return 0

    def __repr__(self):

        """Repr is the same as a Stat object.

        (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime)

        """

        return repr((self.st_mode, 0, 0, 0, 0, 0, self.st_size, self.st_atime,

                     self.st_mtime, self.st_ctime))

cdef object _get_name(WIN32_FIND_DATAW *data):

    """Extract the Unicode name for this file/dir."""

    return PyUnicode_FromUnicode(data.cFileName,

                                 wcslen(data.cFileName))

cdef int _get_mode_bits(WIN32_FIND_DATAW *data): # cannot_raise

    cdef int mode_bits

    mode_bits = 0100666 # writeable file, the most common

    if data.dwFileAttributes & FILE_ATTRIBUTE_READONLY == FILE_ATTRIBUTE_READONLY:

        mode_bits = mode_bits ^ 0222 # remove the write bits

    if data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY == FILE_ATTRIBUTE_DIRECTORY:

        # Remove the FILE bit, set the DIR bit, and set the EXEC bits

        mode_bits = mode_bits ^ 0140111

    return mode_bits

cdef __int64 _get_size(WIN32_FIND_DATAW *data): # cannot_raise

    # Pyrex casts a DWORD into a PyLong anyway, so it is safe to do << 32

    # on a DWORD

    return ((<__int64>data.nFileSizeHigh) << 32) + data.nFileSizeLow

cdef double _ftime_to_timestamp(FILETIME *ft): # cannot_raise

    """Convert from a FILETIME struct into a floating point timestamp.

    The fields of a FILETIME structure are the hi and lo part

    of a 64-bit value expressed in 100 nanosecond units.

    1e7 is one second in such units; 1e-7 the inverse.

    429.4967296 is 2**32 / 1e7 or 2**32 * 1e-7.

    It also uses the epoch 1601-01-01 rather than 1970-01-01

    (taken from posixmodule.c)

    """

    cdef __int64 val

    # NB: This gives slightly different results versus casting to a 64-bit

    #     integer and doing integer math before casting into a floating

    #     point number. But the difference is in the sub millisecond range,

    #     which doesn't seem critical here.

    # secs between epochs: 11,644,473,600

    val = ((<__int64>ft.dwHighDateTime) << 32) + ft.dwLowDateTime

    return (val * 1.0e-7) - 11644473600.0

cdef int _should_skip(WIN32_FIND_DATAW *data): # cannot_raise

    """Is this '.' or '..' so we should skip it?"""

    if (data.cFileName[0] != c'.'):

        return 0

    if data.cFileName[1] == c'\0':

        return 1

    if data.cFileName[1] == c'.' and data.cFileName[2] == c'\0':

        return 1

    return 0

cdef class Win32ReadDir:

    """Read directories on win32."""

    cdef object _directory_kind

    cdef object _file_kind

    def __init__(self):

        self._directory_kind = _readdir_py._directory

        self._file_kind = _readdir_py._file

    def top_prefix_to_starting_dir(self, top, prefix=""):

        """See DirReader.top_prefix_to_starting_dir."""

        global osutils

        if osutils is None:

            from bzrlib import osutils

        return (osutils.safe_utf8(prefix), None, None, None,

                osutils.safe_unicode(top))

    cdef object _get_kind(self, WIN32_FIND_DATAW *data):

        if data.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY:

            return self._directory_kind

        return self._file_kind

    cdef _Win32Stat _get_stat_value(self, WIN32_FIND_DATAW *data):

        """Get the filename and the stat information."""

        cdef _Win32Stat statvalue

        statvalue = _Win32Stat()

        statvalue.st_mode = _get_mode_bits(data)

        statvalue.st_ctime = _ftime_to_timestamp(&data.ftCreationTime)

        statvalue.st_mtime = _ftime_to_timestamp(&data.ftLastWriteTime)

        statvalue.st_atime = _ftime_to_timestamp(&data.ftLastAccessTime)

        statvalue._st_size = _get_size(data)

        return statvalue

    def read_dir(self, prefix, top):

        """Win32 implementation of DirReader.read_dir.

        :seealso: DirReader.read_dir

        """

        cdef WIN32_FIND_DATAW search_data

        cdef HANDLE hFindFile

        cdef int last_err

        cdef WCHAR *query

        cdef int result

        if prefix:

            relprefix = prefix + '/'

        else:

            relprefix = ''

        top_slash = top + '/'

        top_star = top_slash + '*'

        dirblock = []

        query = PyUnicode_AS_UNICODE(top_star)

        hFindFile = FindFirstFileW(query, &search_data)

        if hFindFile == INVALID_HANDLE_VALUE:

            # Raise an exception? This path doesn't seem to exist

            raise WindowsError(GetLastError(), top_star)

        try:

            result = 1

            while result:

                # Skip '.' and '..'

                if _should_skip(&search_data):

                    result = FindNextFileW(hFindFile, &search_data)

                    continue

                name_unicode = _get_name(&search_data)

                name_utf8 = PyUnicode_AsUTF8String(name_unicode)

                PyList_Append(dirblock,

                    (relprefix + name_utf8, name_utf8,

                     self._get_kind(&search_data),

                     self._get_stat_value(&search_data),

                     top_slash + name_unicode))

                result = FindNextFileW(hFindFile, &search_data)

            # FindNextFileW sets GetLastError() == ERROR_NO_MORE_FILES when it

            # actually finishes. If we have anything else, then we have a

            # genuine problem

            last_err = GetLastError()

            if last_err != ERROR_NO_MORE_FILES:

                raise WindowsError(last_err)

        finally:

            result = FindClose(hFindFile)

            if result == 0:

                last_err = GetLastError()

                # TODO: We should probably raise an exception if FindClose

                #       returns an error, however, I don't want to supress an

                #       earlier Exception, so for now, I'm ignoring this

        dirblock.sort(key=operator.itemgetter(1))

        return dirblock

def lstat(path):

    """Equivalent to os.lstat, except match Win32ReadDir._get_stat_value.

    """

    return wrap_stat(os.lstat(path))

def fstat(fd):

    """Like os.fstat, except match Win32ReadDir._get_stat_value

    :seealso: wrap_stat

    """

    return wrap_stat(os.fstat(fd))

def wrap_stat(st):

    """Return a _Win32Stat object, based on the given stat result.

    On Windows, os.fstat(open(fname).fileno()) != os.lstat(fname). This is

    generally because os.lstat and os.fstat differ in what they put into st_ino

    and st_dev. What gets set where seems to also be dependent on the python

    version. So we always set it to 0 to avoid worrying about it.

    """

    cdef _Win32Stat statvalue

    statvalue = _Win32Stat()

    statvalue.st_mode = st.st_mode

    statvalue.st_ctime = st.st_ctime

    statvalue.st_mtime = st.st_mtime

    statvalue.st_atime = st.st_atime

    statvalue._st_size = st.st_size

    return statvalue