fileutils.cpp 16 KB
Newer Older
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
6
**
Eike Ziller's avatar
Eike Ziller committed
7
** Contact: http://www.qt-project.org/
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
**
**
** GNU Lesser General Public License Usage
**
** 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.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
**
**************************************************************************/

#include "fileutils.h"
#include "savefile.h"

34
#include "hostosinfo.h"
35 36
#include "qtcassert.h"

37
#include <QDir>
38
#include <QDebug>
39 40 41 42 43 44
#include <QFileInfo>
#include <QTemporaryFile>
#include <QDateTime>
#include <QDataStream>
#include <QTextStream>
#include <QMessageBox>
45 46 47

namespace Utils {

48 49 50 51 52 53 54 55 56 57 58 59 60 61
/*! \class Utils::FileUtils

  \brief File- and directory-related convenience functions.

  File- and directory-related convenience functions.
*/

/*!
  Removes the directory \a filePath and its subdirectories recursively.

  \note The \a error parameter is optional.

  \return Whether the operation succeeded.
*/
62
bool FileUtils::removeRecursively(const FileName &filePath, QString *error)
63
{
64
    QFileInfo fileInfo = filePath.toFileInfo();
65
    if (!fileInfo.exists() && !fileInfo.isSymLink())
66
        return true;
67
    QFile::setPermissions(filePath.toString(), fileInfo.permissions() | QFile::WriteUser);
68
    if (fileInfo.isDir()) {
69
        QDir dir(filePath.toString());
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85
        dir = dir.canonicalPath();
        if (dir.isRoot()) {
            if (error) {
                *error = QCoreApplication::translate("Utils::FileUtils",
                    "Refusing to remove root directory.");
            }
            return false;
        }
        if (dir.path() == QDir::home().canonicalPath()) {
            if (error) {
                *error = QCoreApplication::translate("Utils::FileUtils",
                    "Refusing to remove your home directory.");
            }
            return false;
        }

86 87 88
        QStringList fileNames = dir.entryList(QDir::Files | QDir::Hidden
                                              | QDir::System | QDir::Dirs | QDir::NoDotAndDotDot);
        foreach (const QString &fileName, fileNames) {
89
            if (!removeRecursively(FileName(filePath).appendPath(fileName), error))
90 91
                return false;
        }
92
        if (!QDir::root().rmdir(dir.path())) {
93 94
            if (error) {
                *error = QCoreApplication::translate("Utils::FileUtils", "Failed to remove directory '%1'.")
95
                        .arg(filePath.toUserOutput());
96 97 98 99
            }
            return false;
        }
    } else {
100
        if (!QFile::remove(filePath.toString())) {
101 102
            if (error) {
                *error = QCoreApplication::translate("Utils::FileUtils", "Failed to remove file '%1'.")
103
                        .arg(filePath.toUserOutput());
104 105 106 107 108 109 110
            }
            return false;
        }
    }
    return true;
}

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
/*!
  Copies the directory specified by \a srcFilePath recursively to \a tgtFilePath. \a tgtFilePath will contain
  the target directory, which will be created. Example usage:

  \code
    QString error;
    book ok = Utils::FileUtils::copyRecursively("/foo/bar", "/foo/baz", &error);
    if (!ok)
      qDebug() << error;
  \endcode

  This will copy the contents of /foo/bar into to the baz directory under /foo, which will be created in the process.

  \note The \a error parameter is optional.

  \return Whether the operation succeeded.
*/
128 129
bool FileUtils::copyRecursively(const FileName &srcFilePath, const FileName &tgtFilePath,
                                QString *error)
130
{
131
    QFileInfo srcFileInfo = srcFilePath.toFileInfo();
132
    if (srcFileInfo.isDir()) {
133
        QDir targetDir(tgtFilePath.toString());
134
        targetDir.cdUp();
135
        if (!targetDir.mkdir(tgtFilePath.toFileInfo().fileName())) {
136 137
            if (error) {
                *error = QCoreApplication::translate("Utils::FileUtils", "Failed to create directory '%1'.")
138
                        .arg(tgtFilePath.toUserOutput());
139 140 141
                return false;
            }
        }
142 143 144
        QDir sourceDir(srcFilePath.toString());
        QStringList fileNames = sourceDir.entryList(QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot
                                                    | QDir::Hidden | QDir::System);
145
        foreach (const QString &fileName, fileNames) {
146 147 148 149
            FileName newSrcFilePath = srcFilePath;
            newSrcFilePath.appendPath(fileName);
            FileName newTgtFilePath = tgtFilePath;
            newTgtFilePath.appendPath(fileName);
150 151 152 153
            if (!copyRecursively(newSrcFilePath, newTgtFilePath, error))
                return false;
        }
    } else {
154
        if (!QFile::copy(srcFilePath.toString(), tgtFilePath.toString())) {
155 156
            if (error) {
                *error = QCoreApplication::translate("Utils::FileUtils", "Could not copy file '%1' to '%2'.")
157
                        .arg(srcFilePath.toUserOutput(), tgtFilePath.toUserOutput());
158 159 160 161 162 163 164
            }
            return false;
        }
    }
    return true;
}

165 166 167 168 169 170 171
/*!
  If \a filePath is a directory, the function will recursively check all files and return
  true if one of them is newer than \a timeStamp. If \a filePath is a single file, true will
  be returned if the file is newer than \timeStamp.

  \return Whether at least one file in \a filePath has a newer date than \a timeStamp.
*/
172
bool FileUtils::isFileNewerThan(const FileName &filePath, const QDateTime &timeStamp)
173
{
174
    QFileInfo fileInfo = filePath.toFileInfo();
175 176 177
    if (!fileInfo.exists() || fileInfo.lastModified() >= timeStamp)
        return true;
    if (fileInfo.isDir()) {
178
        const QStringList dirContents = QDir(filePath.toString())
179 180
            .entryList(QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot);
        foreach (const QString &curFileName, dirContents) {
181
            if (isFileNewerThan(FileName(filePath).appendPath(curFileName), timeStamp))
182 183 184 185 186 187
                return true;
        }
    }
    return false;
}

188 189 190 191 192 193 194 195 196
/*!
  Recursively resolve possibly present symlinks in \a filePath.
  Unlike QFileInfo::canonicalFilePath(), this function will still return the expected target file
  even if the symlink is dangling.

  \note Maximum recursion depth == 16.

  return Symlink target file path.
*/
197
FileName FileUtils::resolveSymlinks(const FileName &path)
198
{
199
    QFileInfo f = path.toFileInfo();
200 201 202 203
    int links = 16;
    while (links-- && f.isSymLink())
        f.setFile(f.symLinkTarget());
    if (links <= 0)
204 205
        return FileName();
    return FileName::fromString(f.filePath());
206
}
207

208 209
QByteArray FileReader::fetchQrc(const QString &fileName)
{
210
    QTC_ASSERT(fileName.startsWith(QLatin1Char(':')), return QByteArray());
211 212
    QFile file(fileName);
    bool ok = file.open(QIODevice::ReadOnly);
213
    QTC_ASSERT(ok, qWarning() << fileName << "not there!"; return QByteArray());
214 215 216 217 218
    return file.readAll();
}

bool FileReader::fetch(const QString &fileName, QIODevice::OpenMode mode)
{
219
    QTC_ASSERT(!(mode & ~(QIODevice::ReadOnly | QIODevice::Text)), return false);
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329

    QFile file(fileName);
    if (!file.open(QIODevice::ReadOnly | mode)) {
        m_errorString = tr("Cannot open %1 for reading: %2").arg(
                QDir::toNativeSeparators(fileName), file.errorString());
        return false;
    }
    m_data = file.readAll();
    if (file.error() != QFile::NoError) {
        m_errorString = tr("Cannot read %1: %2").arg(
                QDir::toNativeSeparators(fileName), file.errorString());
        return false;
    }
    return true;
}

bool FileReader::fetch(const QString &fileName, QIODevice::OpenMode mode, QString *errorString)
{
    if (fetch(fileName, mode))
        return true;
    if (errorString)
        *errorString = m_errorString;
    return false;
}

bool FileReader::fetch(const QString &fileName, QIODevice::OpenMode mode, QWidget *parent)
{
    if (fetch(fileName, mode))
        return true;
    if (parent)
        QMessageBox::critical(parent, tr("File Error"), m_errorString);
    return false;
}


FileSaverBase::FileSaverBase()
    : m_hasError(false)
{
}

FileSaverBase::~FileSaverBase()
{
    delete m_file;
}

bool FileSaverBase::finalize()
{
    m_file->close();
    setResult(m_file->error() == QFile::NoError);
    // We delete the object, so it is really closed even if it is a QTemporaryFile.
    delete m_file;
    m_file = 0;
    return !m_hasError;
}

bool FileSaverBase::finalize(QString *errStr)
{
    if (finalize())
        return true;
    if (errStr)
        *errStr = errorString();
    return false;
}

bool FileSaverBase::finalize(QWidget *parent)
{
    if (finalize())
        return true;
    QMessageBox::critical(parent, tr("File Error"), errorString());
    return false;
}

bool FileSaverBase::write(const char *data, int len)
{
    if (m_hasError)
        return false;
    return setResult(m_file->write(data, len) == len);
}

bool FileSaverBase::write(const QByteArray &bytes)
{
    if (m_hasError)
        return false;
    return setResult(m_file->write(bytes) == bytes.count());
}

bool FileSaverBase::setResult(bool ok)
{
    if (!ok && !m_hasError) {
        m_errorString = tr("Cannot write file %1. Disk full?").arg(
                QDir::toNativeSeparators(m_fileName));
        m_hasError = true;
    }
    return ok;
}

bool FileSaverBase::setResult(QTextStream *stream)
{
#if QT_VERSION >= QT_VERSION_CHECK(4, 8, 0)
    stream->flush();
    return setResult(stream->status() == QTextStream::Ok);
#else
    Q_UNUSED(stream)
    return true;
#endif
}

bool FileSaverBase::setResult(QDataStream *stream)
{
#if QT_VERSION >= QT_VERSION_CHECK(4, 8, 0)
330
    return setResult(stream->status() == QDataStream::Ok);
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
#else
    Q_UNUSED(stream)
    return true;
#endif
}

bool FileSaverBase::setResult(QXmlStreamWriter *stream)
{
#if QT_VERSION >= QT_VERSION_CHECK(4, 8, 0)
    return setResult(!stream->hasError());
#else
    Q_UNUSED(stream)
    return true;
#endif
}


FileSaver::FileSaver(const QString &filename, QIODevice::OpenMode mode)
{
    m_fileName = filename;
    if (mode & (QIODevice::ReadOnly | QIODevice::Append)) {
        m_file = new QFile(filename);
        m_isSafe = false;
    } else {
        m_file = new SaveFile(filename);
        m_isSafe = true;
    }
    if (!m_file->open(QIODevice::WriteOnly | mode)) {
        QString err = QFile::exists(filename) ?
                tr("Cannot overwrite file %1: %2") : tr("Cannot create file %1: %2");
        m_errorString = err.arg(QDir::toNativeSeparators(filename), m_file->errorString());
        m_hasError = true;
    }
}

bool FileSaver::finalize()
{
    if (!m_isSafe)
        return FileSaverBase::finalize();

    SaveFile *sf = static_cast<SaveFile *>(m_file);
    if (m_hasError)
        sf->rollback();
    else
        setResult(sf->commit());
    delete sf;
    m_file = 0;
    return !m_hasError;
}

TempFileSaver::TempFileSaver(const QString &templ)
    : m_autoRemove(true)
{
    QTemporaryFile *tempFile = new QTemporaryFile();
    if (!templ.isEmpty())
        tempFile->setFileTemplate(templ);
    tempFile->setAutoRemove(false);
    if (!tempFile->open()) {
        m_errorString = tr("Cannot create temporary file in %1: %2").arg(
                QDir::toNativeSeparators(QFileInfo(tempFile->fileTemplate()).absolutePath()),
                tempFile->errorString());
        m_hasError = true;
    }
    m_file = tempFile;
    m_fileName = tempFile->fileName();
}

TempFileSaver::~TempFileSaver()
{
    delete m_file;
    m_file = 0;
    if (m_autoRemove)
        QFile::remove(m_fileName);
}

406 407 408 409 410 411 412
/*! \class Utils::FileName

    \brief A light-weight convenience class for filenames

    On windows filenames are compared case insensitively.
*/

Daniel Teske's avatar
Daniel Teske committed
413 414 415 416 417 418
FileName::FileName()
    : QString()
{

}

419
/// Constructs a FileName from \a info
Daniel Teske's avatar
Daniel Teske committed
420 421 422 423 424
FileName::FileName(const QFileInfo &info)
    : QString(info.absoluteFilePath())
{
}

425 426 427 428 429 430 431
/// \returns a QFileInfo
QFileInfo FileName::toFileInfo() const
{
    return QFileInfo(*this);
}

/// \returns a QString for passing on to QString based APIs
Daniel Teske's avatar
Daniel Teske committed
432 433 434 435 436
QString FileName::toString() const
{
    return QString(*this);
}

437 438 439 440 441 442 443
/// \returns a QString to display to the user
/// Converts the separators to the native format
QString FileName::toUserOutput() const
{
    return QDir::toNativeSeparators(toString());
}

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
/// Find the parent directory of a given directory.

/// Returns an empty FileName if the current dirctory is already
/// a root level directory.

/// \returns \a FileName with the last segment removed.
FileName FileName::parentDir() const
{
    const QString basePath = toString();
    if (basePath.isEmpty())
        return FileName();

    const QDir base(basePath);
    if (base.isRoot())
        return FileName();

    const QString path = basePath + QLatin1String("/..");
    const QString parent = QDir::cleanPath(path);

    return FileName::fromString(parent);
}

466 467
/// Constructs a FileName from \a fileName
/// \a fileName is not checked for validity.
Daniel Teske's avatar
Daniel Teske committed
468 469 470 471 472
FileName FileName::fromString(const QString &filename)
{
    return FileName(filename);
}

473 474 475 476 477 478 479 480
/// Constructs a FileName from \a fileName
/// \a fileName is only passed through QDir::cleanPath
/// and QDir::fromNativeSeparators
FileName FileName::fromUserInput(const QString &filename)
{
    return FileName(QDir::cleanPath(QDir::fromNativeSeparators(filename)));
}

Daniel Teske's avatar
Daniel Teske committed
481 482 483 484 485
FileName::FileName(const QString &string)
    : QString(string)
{

}
486

Daniel Teske's avatar
Daniel Teske committed
487 488
bool FileName::operator==(const FileName &other) const
{
489
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) == 0;
Daniel Teske's avatar
Daniel Teske committed
490 491
}

492 493 494 495 496
bool FileName::operator!=(const FileName &other) const
{
    return !(*this == other);
}

Daniel Teske's avatar
Daniel Teske committed
497 498
bool FileName::operator<(const FileName &other) const
{
499
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) < 0;
Daniel Teske's avatar
Daniel Teske committed
500 501 502 503
}

bool FileName::operator<=(const FileName &other) const
{
504
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) <= 0;
Daniel Teske's avatar
Daniel Teske committed
505 506 507 508 509 510 511 512 513 514 515 516
}

bool FileName::operator>(const FileName &other) const
{
    return other < *this;
}

bool FileName::operator>=(const FileName &other) const
{
    return other <= *this;
}

517 518
/// \returns whether FileName is a child of \a s
bool FileName::isChildOf(const FileName &s) const
Daniel Teske's avatar
Daniel Teske committed
519
{
520
    if (!QString::startsWith(s, HostOsInfo::fileNameCaseSensitivity()))
521 522 523
        return false;
    if (size() <= s.size())
        return false;
524
    return at(s.size()) == QLatin1Char('/');
Daniel Teske's avatar
Daniel Teske committed
525 526
}

527 528 529 530 531 532
/// \overload
bool FileName::isChildOf(const QDir &dir) const
{
    return isChildOf(Utils::FileName::fromString(dir.absolutePath()));
}

533
/// \returns whether FileName endsWith \a s
Daniel Teske's avatar
Daniel Teske committed
534 535
bool FileName::endsWith(const QString &s) const
{
536
    return QString::endsWith(s, HostOsInfo::fileNameCaseSensitivity());
Daniel Teske's avatar
Daniel Teske committed
537 538
}

539 540 541 542
/// \returns the relativeChildPath of FileName to parent if FileName is a child of parent
/// \note returns a empty FileName if FileName is not a child of parent
/// That is, this never returns a path starting with "../"
FileName FileName::relativeChildPath(const FileName &parent) const
Daniel Teske's avatar
Daniel Teske committed
543
{
544 545 546
    if (!isChildOf(parent))
        return Utils::FileName();
    return FileName(QString::mid(parent.size() + 1, -1));
Daniel Teske's avatar
Daniel Teske committed
547 548
}

549
/// Appends \a s, ensuring a / between the parts
550
FileName &FileName::appendPath(const QString &s)
Daniel Teske's avatar
Daniel Teske committed
551
{
552
    if (!isEmpty() && !QString::endsWith(QLatin1Char('/')))
553 554
        append(QLatin1Char('/'));
    append(s);
555 556 557 558 559 560 561 562 563 564 565 566 567
    return *this;
}

FileName &FileName::append(const QString &str)
{
    QString::append(str);
    return *this;
}

FileName &FileName::append(QChar str)
{
    QString::append(str);
    return *this;
Daniel Teske's avatar
Daniel Teske committed
568 569
}

570
} // namespace Utils
Daniel Teske's avatar
Daniel Teske committed
571

572
QT_BEGIN_NAMESPACE
Daniel Teske's avatar
Daniel Teske committed
573 574
uint qHash(const Utils::FileName &a)
{
575 576
    if (Utils::HostOsInfo::isWindowsHost())
        return qHash(a.toString().toUpper());
Daniel Teske's avatar
Daniel Teske committed
577 578
    return qHash(a.toString());
}
579
QT_END_NAMESPACE