/****************************************************************************

**

** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtCore module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qplatformdefs.h"

#include "qfileinfo.h"

#include "qdatetime.h"

#include "qabstractfileengine.h"

#include "qfsfileengine_p.h"

#include "qglobal.h"

#include "qatomic.h"

#include "qhash.h"

#include "qdir.h"

#include "qfileinfo_p.h"

QT_BEGIN_NAMESPACE

QFileInfoPrivate::QFileInfoPrivate(const QFileInfo *copy)

{

    if(copy) {

        copy->d_func()->data->ref.ref();

        data = copy->d_func()->data;

    } else {

        data = new QFileInfoPrivate::Data;

    }

}

QFileInfoPrivate::~QFileInfoPrivate()

{

    if (!data->ref.deref())

        delete data;

    data = 0;

}

void QFileInfoPrivate::initFileEngine(const QString &file)

{

    detach();

    delete data->fileEngine;

    data->fileEngine = 0;

    data->clear();

    data->fileEngine = QAbstractFileEngine::create(file);

    data->fileName = file;

}

bool QFileInfoPrivate::hasAccess(Access access) const

{

    if (!(getFileFlags(QAbstractFileEngine::FileInfoAll) & QAbstractFileEngine::LocalDiskFlag)) {

        switch (access) {

        case ReadAccess:

            return getFileFlags(QAbstractFileEngine::ReadUserPerm);

        case WriteAccess:

            return getFileFlags(QAbstractFileEngine::WriteUserPerm);

        case ExecuteAccess:

            return getFileFlags(QAbstractFileEngine::ExeUserPerm);

        default:

            return false;

        }

    }

    int mode = 0;

    switch (access) {

    case ReadAccess:

        mode = R_OK;

        break;

    case WriteAccess:

        mode = W_OK;

        break;

    case ExecuteAccess:

        mode = X_OK;

        break;

    };

#ifdef Q_OS_UNIX

    return QT_ACCESS(QFile::encodeName(data->fileName).data(), mode) == 0;

#endif

#ifdef Q_OS_WIN

    if ((access == ReadAccess && !getFileFlags(QAbstractFileEngine::ReadUserPerm))

        || (access == WriteAccess && !getFileFlags(QAbstractFileEngine::WriteUserPerm))) {

        return false;

    }

    if (access == ExecuteAccess)

        return getFileFlags(QAbstractFileEngine::ExeUserPerm);

    return ::_waccess((wchar_t*)QFSFileEnginePrivate::longFileName(data->fileName).utf16(), mode) == 0;

#endif

    return false;

}

void QFileInfoPrivate::detach()

{

    qAtomicDetach(data);

}

QString QFileInfoPrivate::getFileName(QAbstractFileEngine::FileName name) const

{

    if(data->cache_enabled && !data->fileNames[(int)name].isNull())

        return data->fileNames[(int)name];

    QString ret = data->fileEngine->fileName(name);

    if(data->cache_enabled)

        data->fileNames[(int)name] = ret;

    return ret;

}

uint QFileInfoPrivate::getFileFlags(QAbstractFileEngine::FileFlags request) const

{

    // We split the testing into tests for for LinkType, BundleType and the rest.

    // In order to determine if a file is a symlink or not, we have to lstat().

    // If we're not interested in that information, we might as well avoid one

    // extra syscall. Bundle detecton on Mac can be slow, expecially on network

    // paths, so we separate out that as well.

    QAbstractFileEngine::FileFlags flags;

    if (!data->getCachedFlag(CachedFileFlags)) {

        QAbstractFileEngine::FileFlags req = QAbstractFileEngine::FileInfoAll;

        req &= (~QAbstractFileEngine::LinkType);

        req &= (~QAbstractFileEngine::BundleType);

        flags = data->fileEngine->fileFlags(req);

        data->setCachedFlag(CachedFileFlags);

        data->fileFlags |= uint(flags);

    } else {

        flags = QAbstractFileEngine::FileFlags(data->fileFlags & request);

    }

    if (request & QAbstractFileEngine::LinkType) {

        if (!data->getCachedFlag(CachedLinkTypeFlag)) {

            QAbstractFileEngine::FileFlags linkflag;

            linkflag = data->fileEngine->fileFlags(QAbstractFileEngine::LinkType);

            data->setCachedFlag(CachedLinkTypeFlag);

            data->fileFlags |= uint(linkflag);

            flags |= linkflag;

        }

    }

    if (request & QAbstractFileEngine::BundleType) {

        if (!data->getCachedFlag(CachedBundleTypeFlag)) {

            QAbstractFileEngine::FileFlags bundleflag;

            bundleflag = data->fileEngine->fileFlags(QAbstractFileEngine::BundleType);

            data->setCachedFlag(CachedBundleTypeFlag);

            data->fileFlags |= uint(bundleflag);

            flags |= bundleflag;

        }

    }

    // no else branch

    // if we had it cached, it was caught in the previous else branch

    return flags & request;

}

QDateTime &QFileInfoPrivate::getFileTime(QAbstractFileEngine::FileTime request) const

{

    if (!data->cache_enabled)

        data->clearFlags();

    if(request == QAbstractFileEngine::CreationTime) {

        if(data->getCachedFlag(CachedCTime))

            return data->fileTimes[request];

        data->setCachedFlag(CachedCTime);

        return (data->fileTimes[request] = data->fileEngine->fileTime(request));

    }

    if(request == QAbstractFileEngine::ModificationTime) {

        if(data->getCachedFlag(CachedMTime))

            return data->fileTimes[request];

        data->setCachedFlag(CachedMTime);

        return (data->fileTimes[request] = data->fileEngine->fileTime(request));

    }

    if(request == QAbstractFileEngine::AccessTime) {

        if(data->getCachedFlag(CachedATime))

            return data->fileTimes[request];

        data->setCachedFlag(CachedATime);

        return (data->fileTimes[request] = data->fileEngine->fileTime(request));

    }

    return data->fileTimes[0]; //cannot really happen

}

//************* QFileInfo

/*!

    \class QFileInfo

    \reentrant

    \brief The QFileInfo class provides system-independent file information.

    \ingroup io

    \ingroup shared

    QFileInfo provides information about a file's name and position

    (path) in the file system, its access rights and whether it is a

    directory or symbolic link, etc. The file's size and last

    modified/read times are also available. QFileInfo can also be

    used to obtain information about a Qt \l{resource

    system}{resource}.

    A QFileInfo can point to a file with either a relative or an

    absolute file path. Absolute file paths begin with the directory

    separator "/" (or with a drive specification on Windows). Relative

    file names begin with a directory name or a file name and specify

    a path relative to the current working directory. An example of an

    absolute path is the string "/tmp/quartz". A relative path might

    look like "src/fatlib". You can use the function isRelative() to

    check whether a QFileInfo is using a relative or an absolute file

    path. You can call the function makeAbsolute() to convert a

    relative QFileInfo's path to an absolute path.

    The file that the QFileInfo works on is set in the constructor or

    later with setFile(). Use exists() to see if the file exists and

    size() to get its size.

    The file's type is obtained with isFile(), isDir() and

    isSymLink(). The symLinkTarget() function provides the name of the file

    the symlink points to.

    On Unix (including Mac OS X), the symlink has the same size() has

    the file it points to, because Unix handles symlinks

    transparently; similarly, opening a symlink using QFile

    effectively opens the link's target. For example:

    \snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 0

    On Windows, symlinks (shortcuts) are \c .lnk files. The reported

    size() is that of the symlink (not the link's target), and

    opening a symlink using QFile opens the \c .lnk file. For

    example:

    \snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 1

    Elements of the file's name can be extracted with path() and

    fileName(). The fileName()'s parts can be extracted with

    baseName(), suffix() or completeSuffix(). QFileInfo objects to

    directories created by Qt classes will not have a trailing file

    separator. If you wish to use trailing separators in your own file

    info objects, just append one to the file name given to the constructors

    or setFile().

    The file's dates are returned by created(), lastModified() and

    lastRead(). Information about the file's access permissions is

    obtained with isReadable(), isWritable() and isExecutable(). The

    file's ownership is available from owner(), ownerId(), group() and

    groupId(). You can examine a file's permissions and ownership in a

    single statement using the permission() function.

    \section1 Performance Issues

    Some of QFileInfo's functions query the file system, but for

    performance reasons, some functions only operate on the

    file name itself. For example: To return the absolute path of

    a relative file name, absolutePath() has to query the file system.

    The path() function, however, can work on the file name directly,

    and so it is faster.

    \note To speed up performance, QFileInfo caches information about

    the file.

    To speed up performance, QFileInfo caches information about the

    file. Because files can be changed by other users or programs, or

    even by other parts of the same program, there is a function that

    refreshes the file information: refresh(). If you want to switch

    off a QFileInfo's caching and force it to access the file system

    every time you request information from it call setCaching(false).

    \sa QDir, QFile

*/

/*!

    Constructs an empty QFileInfo object.

    Note that an empty QFileInfo object contain no file reference.

    \sa setFile()

*/

QFileInfo::QFileInfo() : d_ptr(new QFileInfoPrivate())

{

}

/*!

    Constructs a new QFileInfo that gives information about the given

    file. The \a file can also include an absolute or relative path.

    \sa setFile(), isRelative(), QDir::setCurrent(), QDir::isRelativePath()

*/

QFileInfo::QFileInfo(const QString &file) : d_ptr(new QFileInfoPrivate())

{

    d_ptr->initFileEngine(file);

}

/*!

    Constructs a new QFileInfo that gives information about file \a

    file.

    If the \a file has a relative path, the QFileInfo will also have a

    relative path.

    \sa isRelative()

*/

QFileInfo::QFileInfo(const QFile &file) : d_ptr(new QFileInfoPrivate())

{

    d_ptr->initFileEngine(file.fileName());

}

/*!

    Constructs a new QFileInfo that gives information about the given

    \a file in the directory \a dir.

    If \a dir has a relative path, the QFileInfo will also have a

    relative path.

    If \a file is an absolute path, then the directory specified

    by \a dir will be disregarded.

    \sa isRelative()

*/

QFileInfo::QFileInfo(const QDir &dir, const QString &file) : d_ptr(new QFileInfoPrivate())

{

    d_ptr->initFileEngine(dir.filePath(file));

}

/*!

    Constructs a new QFileInfo that is a copy of the given \a fileinfo.

*/

QFileInfo::QFileInfo(const QFileInfo &fileinfo) : d_ptr(new QFileInfoPrivate(&fileinfo))

{

}

/*!

    Destroys the QFileInfo and frees its resources.

*/

QFileInfo::~QFileInfo()

{

}

/*!

    \fn bool QFileInfo::operator!=(const QFileInfo &fileinfo)

    Returns true if this QFileInfo object refers to a different file

    than the one specified by \a fileinfo; otherwise returns false.

    \sa operator==()

*/

/*!

    \overload

    \fn bool QFileInfo::operator!=(const QFileInfo &fileinfo) const

*/

/*!

    \overload

*/

bool QFileInfo::operator==(const QFileInfo &fileinfo) const

{

    Q_D(const QFileInfo);

    // ### Qt 5: understand long and short file names on Windows

    // ### (GetFullPathName()).

    if(fileinfo.d_func()->data == d->data)

        return true;

    if(!d->data->fileEngine || !fileinfo.d_func()->data->fileEngine)

        return false;

    if(d->data->fileEngine->caseSensitive() != fileinfo.d_func()->data->fileEngine->caseSensitive())

        return false;

    if(fileinfo.size() == size()) { //if the size isn't the same...

        QString file1 = canonicalFilePath(),

                file2 = fileinfo.canonicalFilePath();

        if(file1.length() == file2.length()) {

            if(!fileinfo.d_func()->data->fileEngine->caseSensitive()) {

                for(int i = 0; i < file1.length(); i++) {

                    if(file1.at(i).toLower() != file2.at(i).toLower())

                        return false;

                }

                return true;

            }

            return (file1 == file2);

        }

    }

    return false;

}

/*!

    Returns true if this QFileInfo object refers to a file in the same

    location as \a fileinfo; otherwise returns false.

    Note that the result of comparing two empty QFileInfo objects,

    containing no file references, is undefined.

    \warning This will not compare two different symbolic links

    pointing to the same file.

    \warning Long and short file names that refer to the same file on Windows

    are treated as if they referred to different files.

    \sa operator!=()

*/

bool QFileInfo::operator==(const QFileInfo &fileinfo)

{

    return const_cast<const QFileInfo *>(this)->operator==(fileinfo);

}

/*!

    Makes a copy of the given \a fileinfo and assigns it to this QFileInfo.

*/

QFileInfo &QFileInfo::operator=(const QFileInfo &fileinfo)

{

    Q_D(QFileInfo);

    qAtomicAssign(d->data, fileinfo.d_func()->data);

    return *this;

}

/*!

    Sets the file that the QFileInfo provides information about to \a

    file.

    The \a file can also include an absolute or relative file path.

    Absolute paths begin with the directory separator (e.g. "/" under

    Unix) or a drive specification (under Windows). Relative file

    names begin with a directory name or a file name and specify a

    path relative to the current directory.

    Example:

    \snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp 2

    \sa isRelative(), QDir::setCurrent(), QDir::isRelativePath()

*/

void QFileInfo::setFile(const QString &file)

{

    *this = QFileInfo(file);

}

/*!

    \overload

    Sets the file that the QFileInfo provides information about to \a

    file.

    If \a file includes a relative path, the QFileInfo will also have

    a relative path.

    \sa isRelative()

*/

void QFileInfo::setFile(const QFile &file)

{

    *this = QFileInfo(file.fileName());

}

/*!

    \overload

    Sets the file that the QFileInfo provides information about to \a

    file in directory \a dir.

    If \a file includes a relative path, the QFileInfo will also

    have a relative path.

    \sa isRelative()

*/

void QFileInfo::setFile(const QDir &dir, const QString &file)

{

    *this = QFileInfo(dir.filePath(file));

}

/*!

    Returns an absolute path including the file name.

    The absolute path name consists of the full path and the file

    name. On Unix this will always begin with the root, '/',

    directory. On Windows this will always begin 'D:/' where D is a

    drive letter, except for network shares that are not mapped to a

    drive letter, in which case the path will begin '//sharename/'.

    QFileInfo will uppercase drive letters. Note that QDir does not do

    this. The code snippet below shows this.

    \snippet doc/src/snippets/code/src_corelib_io_qfileinfo.cpp newstuff

    This function returns the same as filePath(), unless isRelative()

    is true. In contrast to canonicalFilePath(), symbolic links or

    redundant "." or ".." elements are not necessarily removed.

    If the QFileInfo is empty it returns QDir::currentPath().

    \sa filePath(), canonicalFilePath(), isRelative()

*/

QString QFileInfo::absoluteFilePath() const