fileutils.cpp 17.5 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22
** 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.
23
**
hjk's avatar
hjk committed
24 25
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
29 30 31 32

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

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

36
#include <QDir>
37
#include <QDebug>
38 39
#include <QDateTime>
#include <QMessageBox>
40 41 42

namespace Utils {

43 44
/*! \class Utils::FileUtils

45 46
  \brief The FileUtils class contains file and directory related convenience
  functions.
47 48 49 50 51 52 53 54

*/

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

  \note The \a error parameter is optional.

Leena Miettinen's avatar
Leena Miettinen committed
55
  Returns whether the operation succeeded.
56
*/
57
bool FileUtils::removeRecursively(const FileName &filePath, QString *error)
58
{
59
    QFileInfo fileInfo = filePath.toFileInfo();
60
    if (!fileInfo.exists() && !fileInfo.isSymLink())
61
        return true;
62
    QFile::setPermissions(filePath.toString(), fileInfo.permissions() | QFile::WriteUser);
63
    if (fileInfo.isDir()) {
64
        QDir dir(filePath.toString());
65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
        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;
        }

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

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
/*!
  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.

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

160 161 162
/*!
  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
Tobias Hunger's avatar
Tobias Hunger committed
163
  be returned if the file is newer than \a timeStamp.
164

Leena Miettinen's avatar
Leena Miettinen committed
165 166
  Returns whether at least one file in \a filePath has a newer date than
  \a timeStamp.
167
*/
168
bool FileUtils::isFileNewerThan(const FileName &filePath, const QDateTime &timeStamp)
169
{
170
    QFileInfo fileInfo = filePath.toFileInfo();
171 172 173
    if (!fileInfo.exists() || fileInfo.lastModified() >= timeStamp)
        return true;
    if (fileInfo.isDir()) {
174
        const QStringList dirContents = QDir(filePath.toString())
175 176
            .entryList(QDir::Files | QDir::Dirs | QDir::NoDotAndDotDot);
        foreach (const QString &curFileName, dirContents) {
177
            if (isFileNewerThan(FileName(filePath).appendPath(curFileName), timeStamp))
178 179 180 181 182 183
                return true;
        }
    }
    return false;
}

184
/*!
Leena Miettinen's avatar
Leena Miettinen committed
185
  Recursively resolves possibly present symlinks in \a filePath.
186 187 188 189 190
  Unlike QFileInfo::canonicalFilePath(), this function will still return the expected target file
  even if the symlink is dangling.

  \note Maximum recursion depth == 16.

Leena Miettinen's avatar
Leena Miettinen committed
191
  Returns the symlink target file path.
192
*/
193
FileName FileUtils::resolveSymlinks(const FileName &path)
194
{
195
    QFileInfo f = path.toFileInfo();
196 197 198 199
    int links = 16;
    while (links-- && f.isSymLink())
        f.setFile(f.symLinkTarget());
    if (links <= 0)
200 201
        return FileName();
    return FileName::fromString(f.filePath());
202
}
203

204 205 206 207
/*!
  Like QDir::toNativeSeparators(), but use prefix '~' instead of $HOME on unix systems when an
  absolute path is given.

Leena Miettinen's avatar
Leena Miettinen committed
208
  Returns the possibly shortened path with native separators.
209 210 211 212 213 214 215 216 217 218 219 220 221
*/
QString FileUtils::shortNativePath(const FileName &path)
{
    if (HostOsInfo::isAnyUnixHost()) {
        const FileName home = FileName::fromString(QDir::cleanPath(QDir::homePath()));
        if (path.isChildOf(home)) {
            return QLatin1Char('~') + QDir::separator()
                + QDir::toNativeSeparators(path.relativeChildPath(home).toString());
        }
    }
    return path.toUserOutput();
}

222 223 224 225 226 227 228 229 230 231 232 233
QString FileUtils::fileSystemFriendlyName(const QString &name)
{
    QString result = name;
    result.replace(QRegExp(QLatin1String("\\W")), QLatin1String("_"));
    result.replace(QRegExp(QLatin1String("_+")), QLatin1String("_")); // compact _
    result.remove(QRegExp(QLatin1String("^_*"))); // remove leading _
    result.remove(QRegExp(QLatin1String("_+$"))); // remove trailing _
    if (result.isEmpty())
        result = QLatin1String("unknown");
    return result;
}

234 235 236 237 238 239
bool FileUtils::makeWritable(const FileName &path)
{
    const QString fileName = path.toString();
    return QFile::setPermissions(fileName, QFile::permissions(fileName) | QFile::WriteUser);
}

240 241
QByteArray FileReader::fetchQrc(const QString &fileName)
{
242
    QTC_ASSERT(fileName.startsWith(QLatin1Char(':')), return QByteArray());
243 244
    QFile file(fileName);
    bool ok = file.open(QIODevice::ReadOnly);
245
    QTC_ASSERT(ok, qWarning() << fileName << "not there!"; return QByteArray());
246 247 248 249 250
    return file.readAll();
}

bool FileReader::fetch(const QString &fileName, QIODevice::OpenMode mode)
{
251
    QTC_ASSERT(!(mode & ~(QIODevice::ReadOnly | QIODevice::Text)), return false);
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 330 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

    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)
{
    stream->flush();
    return setResult(stream->status() == QTextStream::Ok);
}

bool FileSaverBase::setResult(QDataStream *stream)
{
356
    return setResult(stream->status() == QDataStream::Ok);
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
}

bool FileSaverBase::setResult(QXmlStreamWriter *stream)
{
    return setResult(!stream->hasError());
}


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);
389 390 391 392
    if (m_hasError) {
        if (sf->isOpen())
            sf->rollback();
    } else {
393
        setResult(sf->commit());
394
    }
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
    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);
}

425 426
/*! \class Utils::FileName

427
    \brief The FileName class is a light-weight convenience class for filenames.
428 429 430 431

    On windows filenames are compared case insensitively.
*/

Daniel Teske's avatar
Daniel Teske committed
432 433 434 435 436 437
FileName::FileName()
    : QString()
{

}

438
/// Constructs a FileName from \a info
Daniel Teske's avatar
Daniel Teske committed
439 440 441 442 443
FileName::FileName(const QFileInfo &info)
    : QString(info.absoluteFilePath())
{
}

444 445 446 447 448 449 450
/// \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
451 452 453 454 455
QString FileName::toString() const
{
    return QString(*this);
}

456 457 458 459 460 461 462
/// \returns a QString to display to the user
/// Converts the separators to the native format
QString FileName::toUserOutput() const
{
    return QDir::toNativeSeparators(toString());
}

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
/// 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);
}

485 486
/// Constructs a FileName from \a fileName
/// \a fileName is not checked for validity.
Daniel Teske's avatar
Daniel Teske committed
487 488 489 490 491
FileName FileName::fromString(const QString &filename)
{
    return FileName(filename);
}

492 493 494 495
/// Constructs a FileName from \a fileName
/// \a fileName is only passed through QDir::cleanPath
FileName FileName::fromUserInput(const QString &filename)
{
496 497
    QString clean = QDir::cleanPath(filename);
    if (clean.startsWith(QLatin1String("~/")))
Eike Ziller's avatar
Eike Ziller committed
498
        clean = QDir::homePath() + clean.mid(1);
499
    return FileName(clean);
500 501
}

Daniel Teske's avatar
Daniel Teske committed
502 503 504 505 506
FileName::FileName(const QString &string)
    : QString(string)
{

}
507

Daniel Teske's avatar
Daniel Teske committed
508 509
bool FileName::operator==(const FileName &other) const
{
510
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) == 0;
Daniel Teske's avatar
Daniel Teske committed
511 512
}

513 514 515 516 517
bool FileName::operator!=(const FileName &other) const
{
    return !(*this == other);
}

Daniel Teske's avatar
Daniel Teske committed
518 519
bool FileName::operator<(const FileName &other) const
{
520
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) < 0;
Daniel Teske's avatar
Daniel Teske committed
521 522 523 524
}

bool FileName::operator<=(const FileName &other) const
{
525
    return QString::compare(*this, other, HostOsInfo::fileNameCaseSensitivity()) <= 0;
Daniel Teske's avatar
Daniel Teske committed
526 527 528 529 530 531 532 533 534 535 536 537
}

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

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

538 539
/// \returns whether FileName is a child of \a s
bool FileName::isChildOf(const FileName &s) const
Daniel Teske's avatar
Daniel Teske committed
540
{
541 542
    if (s.isEmpty())
        return false;
543
    if (!QString::startsWith(s, HostOsInfo::fileNameCaseSensitivity()))
544 545 546
        return false;
    if (size() <= s.size())
        return false;
547 548 549 550
    // s is root, '/' was already tested in startsWith
    if (s.QString::endsWith(QLatin1Char('/')))
        return true;
    // s is a directory, next character should be '/' (/tmpdir is NOT a child of /tmp)
551
    return at(s.size()) == QLatin1Char('/');
Daniel Teske's avatar
Daniel Teske committed
552 553
}

554 555 556 557 558 559
/// \overload
bool FileName::isChildOf(const QDir &dir) const
{
    return isChildOf(Utils::FileName::fromString(dir.absolutePath()));
}

560
/// \returns whether FileName endsWith \a s
Daniel Teske's avatar
Daniel Teske committed
561 562
bool FileName::endsWith(const QString &s) const
{
563
    return QString::endsWith(s, HostOsInfo::fileNameCaseSensitivity());
Daniel Teske's avatar
Daniel Teske committed
564 565
}

566 567 568 569
/// \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
570
{
571 572 573
    if (!isChildOf(parent))
        return Utils::FileName();
    return FileName(QString::mid(parent.size() + 1, -1));
Daniel Teske's avatar
Daniel Teske committed
574 575
}

576
/// Appends \a s, ensuring a / between the parts
577
FileName &FileName::appendPath(const QString &s)
Daniel Teske's avatar
Daniel Teske committed
578
{
579
    if (!isEmpty() && !QString::endsWith(QLatin1Char('/')))
580 581
        append(QLatin1Char('/'));
    append(s);
582 583 584 585 586 587 588 589 590 591 592 593 594
    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
595 596
}

597
} // namespace Utils
Daniel Teske's avatar
Daniel Teske committed
598

599
QT_BEGIN_NAMESPACE
Daniel Teske's avatar
Daniel Teske committed
600 601
uint qHash(const Utils::FileName &a)
{
602 603
    if (Utils::HostOsInfo::isWindowsHost())
        return qHash(a.toString().toUpper());
Daniel Teske's avatar
Daniel Teske committed
604 605
    return qHash(a.toString());
}
606
QT_END_NAMESPACE