KisBackup.cpp

Go to the documentation of this file.

/*
    This file is part of the KDE libraries
 
    SPDX-FileCopyrightText: 1999 Waldo Bastian <bastian@kde.org>
    SPDX-FileCopyrightText: 2006 Allen Winter <winter@kde.org>
    SPDX-FileCopyrightText: 2006 Gregory S. Hayes <syncomm@kde.org>
    SPDX-FileCopyrightText: 2006 Jaison Lee <lee.jaison@gmail.com>
    SPDX-FileCopyrightText: 2011 Romain Perier <bambi@ubuntu.com>
 
    SPDX-License-Identifier: LGPL-2.0-only
*/
 
#include "KisBackup.h"
 
#include <QDebug>
#include <QDir>
#include <QFileInfo>
 
bool KisBackup::backupFile(const QString &qFilename, const QString &backupDir)
{
    return (simpleBackupFile(qFilename, backupDir, QStringLiteral("~")));
}
 
bool KisBackup::simpleBackupFile(const QString &qFilename, const QString &backupDir, const QString &backupExtension)
{
    QString backupFileName = qFilename + backupExtension;
 
    if (!backupDir.isEmpty()) {
        QFileInfo fileInfo(qFilename);
        backupFileName = backupDir + QLatin1Char('/') + fileInfo.fileName() + backupExtension;
    }
 
    //    qCDebug(KCOREADDONS_DEBUG) << "KisBackup copying " << qFilename << " to " << backupFileName;
    QFile::remove(backupFileName);
    return QFile::copy(qFilename, backupFileName);
}
 
bool KisBackup::numberedBackupFile(const QString &qFilename, const QString &backupDir, const QString &backupExtension, const uint maxBackups)
{
    QFileInfo fileInfo(qFilename);
 
    // The backup file name template.
    QString sTemplate;
 
    if (backupDir.isEmpty()) {
        sTemplate = qFilename + QLatin1String(".%1") + backupExtension;
    } else {
        sTemplate = backupDir + QLatin1Char('/') + fileInfo.fileName() + QLatin1String(".%1") + backupExtension;
    }
    // First, search backupDir for numbered backup files to remove.
    // Remove all with number 'maxBackups' and greater.
    QDir d = backupDir.isEmpty() ? fileInfo.dir() : backupDir;
    d.setFilter(QDir::Files | QDir::Hidden | QDir::NoSymLinks);
 
    QString nameFilter = fileInfo.fileName() + QLatin1String(".*") + backupExtension;
    nameFilter.replace('[', '*');
    nameFilter.replace(']', '*');
 
    const QStringList nameFilters = QStringList(nameFilter);
    d.setNameFilters(nameFilters);
    d.setSorting(QDir::Name);
 
    uint maxBackupFound = 0;
    const QFileInfoList infoList = d.entryInfoList();
    for (const QFileInfo &fi : infoList) {
        if (fi.fileName().endsWith(backupExtension)) {
            // sTemp holds the file name, without the ending backupExtension
            QString sTemp = fi.fileName();
 
            sTemp.truncate(fi.fileName().length() - backupExtension.length());
 
            // compute the backup number
            int idex = sTemp.lastIndexOf(QLatin1Char('.'));
            if (idex > 0) {
                bool ok;
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
                const uint num = QStringView(sTemp).mid(idex + 1).toUInt(&ok);
#else
                const uint num = sTemp.midRef(idex + 1).toUInt(&ok);
#endif
                if (ok) {
                    if (num >= maxBackups) {
                        QFile::remove(fi.filePath());
                    } else {
                        maxBackupFound = qMax(maxBackupFound, num);
                    }
                }
            }
        }
    }
 
    // Next, rename max-1 to max, max-2 to max-1, etc.
    QString to = sTemplate.arg(maxBackupFound + 1);
 
    for (int i = maxBackupFound; i > 0; i--) {
        QString from = sTemplate.arg(i);
        //        qCDebug(KCOREADDONS_DEBUG) << "KisBackup renaming " << from << " to " << to;
        QFile::rename(from, to);
        to = from;
    }
 
    // Finally create most recent backup by copying the file to backup number 1.
    //    qCDebug(KCOREADDONS_DEBUG) << "KisBackup copying " << qFilename << " to " << sTemplate.arg(1);
    bool r = QFile::copy(qFilename, sTemplate.arg(1));
    return r;
}