Merge pull request #13995 from glassez/rename-files

Improve content file/folder names handling

src/base/CMakeLists.txt

@@ -2,6 +2,7 @@ add_library(qbt_base STATIC
     # headers
     algorithm.h
     asyncfilestorage.h
+    bittorrent/abstractfilestorage.h
     bittorrent/addtorrentparams.h
     bittorrent/bandwidthscheduler.h
     bittorrent/cachestatus.h
@@ -89,6 +90,7 @@ add_library(qbt_base STATIC
 
     # sources
     asyncfilestorage.cpp
+    bittorrent/abstractfilestorage.cpp
     bittorrent/bandwidthscheduler.cpp
     bittorrent/customstorage.cpp
     bittorrent/downloadpriority.cpp

src/base/base.pri

@@ -1,6 +1,7 @@
 HEADERS += \
     $$PWD/algorithm.h \
     $$PWD/asyncfilestorage.h \
+    $$PWD/bittorrent/abstractfilestorage.h \
     $$PWD/bittorrent/addtorrentparams.h \
     $$PWD/bittorrent/bandwidthscheduler.h \
     $$PWD/bittorrent/cachestatus.h \
@@ -89,6 +90,7 @@ HEADERS += \
 
 SOURCES += \
     $$PWD/asyncfilestorage.cpp \
+    $$PWD/bittorrent/abstractfilestorage.cpp \
     $$PWD/bittorrent/bandwidthscheduler.cpp \
     $$PWD/bittorrent/customstorage.cpp \
     $$PWD/bittorrent/downloadpriority.cpp \

src/base/bittorrent/abstractfilestorage.cpp

@@ -0,0 +1,140 @@
+/*
+ * Bittorrent Client using Qt and libtorrent.
+ * Copyright (C) 2020  Vladimir Golovnev <glassez@yandex.ru>
+ *
+ * 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.
+ *
+ * In addition, as a special exception, the copyright holders give permission to
+ * link this program with the OpenSSL project's "OpenSSL" library (or with
+ * modified versions of it that use the same license as the "OpenSSL" library),
+ * and distribute the linked executables. You must obey the GNU General Public
+ * License in all respects for all of the code used other than "OpenSSL".  If you
+ * modify file(s), you may extend this exception to your version of the file(s),
+ * but you are not obligated to do so. If you do not wish to do so, delete this
+ * exception statement from your version.
+ */
+
+#include "abstractfilestorage.h"
+
+#include <QDir>
+#include <QHash>
+#include <QVector>
+
+#include "base/bittorrent/common.h"
+#include "base/exceptions.h"
+#include "base/utils/fs.h"
+
+#if defined(Q_OS_WIN)
+const Qt::CaseSensitivity CASE_SENSITIVITY {Qt::CaseInsensitive};
+#else
+const Qt::CaseSensitivity CASE_SENSITIVITY {Qt::CaseSensitive};
+#endif
+
+namespace
+{
+    bool areSameFileNames(QString first, QString second)
+    {
+        if (first.endsWith(QB_EXT, Qt::CaseInsensitive))
+            first.chop(QB_EXT.size());
+        if (second.endsWith(QB_EXT, Qt::CaseInsensitive))
+            second.chop(QB_EXT.size());
+        return QString::compare(first, second, CASE_SENSITIVITY) == 0;
+    }
+}
+
+void BitTorrent::AbstractFileStorage::renameFile(const QString &oldPath, const QString &newPath)
+{
+    if (!Utils::Fs::isValidFileSystemName(oldPath, true))
+        throw RuntimeError {tr("The old path is invalid: '%1'.").arg(oldPath)};
+    if (!Utils::Fs::isValidFileSystemName(newPath, true))
+        throw RuntimeError {tr("The new path is invalid: '%1'.").arg(newPath)};
+
+    const QString oldFilePath = Utils::Fs::toUniformPath(oldPath);
+    if (oldFilePath.endsWith(QLatin1Char {'/'}))
+        throw RuntimeError {tr("Invalid file path: '%1'.").arg(oldFilePath)};
+
+    const QString newFilePath = Utils::Fs::toUniformPath(newPath);
+    if (newFilePath.endsWith(QLatin1Char {'/'}))
+        throw RuntimeError {tr("Invalid file path: '%1'.").arg(newFilePath)};
+    if (QDir().isAbsolutePath(newFilePath))
+        throw RuntimeError {tr("Absolute path isn't allowed: '%1'.").arg(newFilePath)};
+
+    int renamingFileIndex = -1;
+    for (int i = 0; i < filesCount(); ++i)
+    {
+        const QString path = filePath(i);
+
+        if ((renamingFileIndex < 0) && areSameFileNames(path, oldFilePath))
+            renamingFileIndex = i;
+
+        if (areSameFileNames(path, newFilePath))
+            throw RuntimeError {tr("The file already exists: '%1'.").arg(newFilePath)};
+    }
+
+    if (renamingFileIndex < 0)
+        throw RuntimeError {tr("No such file: '%1'.").arg(oldFilePath)};
+
+    const auto extAdjusted = [](const QString &path, const bool needExt) -> QString
+    {
+        if (path.endsWith(QB_EXT, Qt::CaseInsensitive) == needExt)
+            return path;
+
+        return (needExt ? (path + QB_EXT) : (path.left(path.size() - QB_EXT.size())));
+    };
+
+    renameFile(renamingFileIndex, extAdjusted(newFilePath, filePath(renamingFileIndex).endsWith(QB_EXT, Qt::CaseInsensitive)));
+}
+
+void BitTorrent::AbstractFileStorage::renameFolder(const QString &oldPath, const QString &newPath)
+{
+    if (!Utils::Fs::isValidFileSystemName(oldPath, true))
+        throw RuntimeError {tr("The old path is invalid: '%1'.").arg(oldPath)};
+    if (!Utils::Fs::isValidFileSystemName(newPath, true))
+        throw RuntimeError {tr("The new path is invalid: '%1'.").arg(newPath)};
+
+    const auto cleanFolderPath = [](const QString &path) -> QString
+    {
+        const QString uniformPath = Utils::Fs::toUniformPath(path);
+        return (uniformPath.endsWith(QLatin1Char {'/'}) ? uniformPath : uniformPath + QLatin1Char {'/'});
+    };
+
+    const QString oldFolderPath = cleanFolderPath(oldPath);
+    const QString newFolderPath = cleanFolderPath(newPath);
+    if (QDir().isAbsolutePath(newFolderPath))
+        throw RuntimeError {tr("Absolute path isn't allowed: '%1'.").arg(newFolderPath)};
+
+    QVector<int> renamingFileIndexes;
+    renamingFileIndexes.reserve(filesCount());
+
+    for (int i = 0; i < filesCount(); ++i)
+    {
+        const QString path = filePath(i);
+
+        if (path.startsWith(oldFolderPath, CASE_SENSITIVITY))
+            renamingFileIndexes.append(i);
+
+        if (path.startsWith(newFolderPath, CASE_SENSITIVITY))
+            throw RuntimeError {tr("The folder already exists: '%1'.").arg(newFolderPath)};
+    }
+
+    if (renamingFileIndexes.isEmpty())
+        throw RuntimeError {tr("No such folder: '%1'.").arg(oldFolderPath)};
+
+    for (const int index : renamingFileIndexes)
+    {
+        const QString newFilePath = newFolderPath + filePath(index).mid(oldFolderPath.size());
+        renameFile(index, newFilePath);
+    }
+}

src/base/bittorrent/abstractfilestorage.h

@@ -0,0 +1,53 @@
+/*
+ * Bittorrent Client using Qt and libtorrent.
+ * Copyright (C) 2020  Vladimir Golovnev <glassez@yandex.ru>
+ *
+ * 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.
+ *
+ * In addition, as a special exception, the copyright holders give permission to
+ * link this program with the OpenSSL project's "OpenSSL" library (or with
+ * modified versions of it that use the same license as the "OpenSSL" library),
+ * and distribute the linked executables. You must obey the GNU General Public
+ * License in all respects for all of the code used other than "OpenSSL".  If you
+ * modify file(s), you may extend this exception to your version of the file(s),
+ * but you are not obligated to do so. If you do not wish to do so, delete this
+ * exception statement from your version.
+ */
+
+#pragma once
+
+#include <QtGlobal>
+#include <QCoreApplication>
+
+class QString;
+
+namespace BitTorrent
+{
+    class AbstractFileStorage
+    {
+        Q_DECLARE_TR_FUNCTIONS(AbstractFileStorage)
+
+    public:
+        virtual int filesCount() const = 0;
+        virtual QString filePath(int index) const = 0;
+        virtual QString fileName(int index) const = 0;
+        virtual qlonglong fileSize(int index) const = 0;
+
+        virtual void renameFile(int index, const QString &name) = 0;
+
+        void renameFile(const QString &oldPath, const QString &newPath);
+        void renameFolder(const QString &oldPath, const QString &newPath);
+    };
+}

src/base/bittorrent/torrenthandle.h

@@ -33,6 +33,8 @@
 #include <QString>
 #include <QtContainerFwd>
 
+#include "abstractfilestorage.h"
+
 class QBitArray;
 class QDateTime;
 class QUrl;
@@ -89,7 +91,7 @@ namespace BitTorrent
 
     uint qHash(TorrentState key, uint seed);
 
-    class TorrentHandle
+    class TorrentHandle : public AbstractFileStorage
     {
     public:
         static const qreal USE_GLOBAL_RATIO;
@@ -177,7 +179,6 @@ namespace BitTorrent
         virtual bool removeTag(const QString &tag) = 0;
         virtual void removeAllTags() = 0;
 
-        virtual int filesCount() const = 0;
         virtual int piecesCount() const = 0;
         virtual int piecesHave() const = 0;
         virtual qreal progress() const = 0;
@@ -185,9 +186,6 @@ namespace BitTorrent
         virtual qreal ratioLimit() const = 0;
         virtual int seedingTimeLimit() const = 0;
 
-        virtual QString filePath(int index) const = 0;
-        virtual QString fileName(int index) const = 0;
-        virtual qlonglong fileSize(int index) const = 0;
         virtual QStringList absoluteFilePaths() const = 0;
         virtual QVector<DownloadPriority> filePriorities() const = 0;
 
@@ -273,7 +271,6 @@ namespace BitTorrent
         virtual void forceReannounce(int index = -1) = 0;
         virtual void forceDHTAnnounce() = 0;
         virtual void forceRecheck() = 0;
-        virtual void renameFile(int index, const QString &name) = 0;
         virtual void prioritizeFiles(const QVector<DownloadPriority> &priorities) = 0;
         virtual void setRatioLimit(qreal limit) = 0;
         virtual void setSeedingTimeLimit(int limit) = 0;

src/base/bittorrent/torrenthandleimpl.cpp

@@ -1405,11 +1405,12 @@ void TorrentHandleImpl::moveStorage(const QString &newPath, const MoveStorageMod
     }
 }
 
-void TorrentHandleImpl::renameFile(const int index, const QString &name)
+void TorrentHandleImpl::renameFile(const int index, const QString &path)
 {
-    m_oldPath[lt::file_index_t {index}].push_back(filePath(index));
+    const QString oldPath = filePath(index);
+    m_oldPath[lt::file_index_t {index}].push_back(oldPath);
     ++m_renameCount;
-    m_nativeHandle.rename_file(lt::file_index_t {index}, Utils::Fs::toNativePath(name).toStdString());
+    m_nativeHandle.rename_file(lt::file_index_t {index}, Utils::Fs::toNativePath(path).toStdString());
 }
 
 void TorrentHandleImpl::handleStateUpdate(const lt::torrent_status &nativeStatus)
@@ -1826,7 +1827,7 @@ void TorrentHandleImpl::manageIncompleteFiles()
         QString name = filePath(i);
         if (isAppendExtensionEnabled && (fileSize(i) > 0) && (fp[i] < 1))
         {
-            if (!name.endsWith(QB_EXT))
+            if (!name.endsWith(QB_EXT, Qt::CaseInsensitive))
             {
                 const QString newName = name + QB_EXT;
                 qDebug() << "Renaming" << name << "to" << newName;
@@ -1835,7 +1836,7 @@ void TorrentHandleImpl::manageIncompleteFiles()
         }
         else
         {
-            if (name.endsWith(QB_EXT))
+            if (name.endsWith(QB_EXT, Qt::CaseInsensitive))
             {
                 const QString oldName = name;
                 name.chop(QB_EXT.size());

src/base/bittorrent/torrenthandleimpl.h

@@ -220,7 +220,7 @@ namespace BitTorrent
         void forceReannounce(int index = -1) override;
         void forceDHTAnnounce() override;
         void forceRecheck() override;
-        void renameFile(int index, const QString &name) override;
+        void renameFile(int index, const QString &path) override;
         void prioritizeFiles(const QVector<DownloadPriority> &priorities) override;
         void setRatioLimit(qreal limit) override;
         void setSeedingTimeLimit(int limit) override;

src/base/bittorrent/torrentinfo.h

@@ -34,6 +34,7 @@
 #include <QtContainerFwd>
 
 #include "base/indexrange.h"
+#include "abstractfilestorage.h"
 #include "torrentcontentlayout.h"
 
 class QByteArray;
@@ -46,7 +47,7 @@ namespace BitTorrent
     class InfoHash;
     class TrackerEntry;
 
-    class TorrentInfo
+    class TorrentInfo final : public AbstractFileStorage
     {
         Q_DECLARE_TR_FUNCTIONS(TorrentInfo)
 
@@ -68,15 +69,15 @@ namespace BitTorrent
         QString comment() const;
         bool isPrivate() const;
         qlonglong totalSize() const;
-        int filesCount() const;
+        int filesCount() const override;
         int pieceLength() const;
         int pieceLength(int index) const;
         int piecesCount() const;
-        QString filePath(int index) const;
+        QString filePath(int index) const override;
         QStringList filePaths() const;
-        QString fileName(int index) const;
+        QString fileName(int index) const override;
         QString origFilePath(int index) const;
-        qlonglong fileSize(int index) const;
+        qlonglong fileSize(int index) const override;
         qlonglong fileOffset(int index) const;
         QVector<TrackerEntry> trackers() const;
         QVector<QUrl> urlSeeds() const;
@@ -91,7 +92,7 @@ namespace BitTorrent
         PieceRange filePieces(const QString &file) const;
         PieceRange filePieces(int fileIndex) const;
 
-        void renameFile(int index, const QString &newPath);
+        void renameFile(int index, const QString &newPath) override;
 
         QString rootFolder() const;
         bool hasRootFolder() const;

src/base/utils/fs.cpp

@@ -95,7 +95,7 @@ QString Utils::Fs::folderName(const QString &filePath)
     const QString path = toUniformPath(filePath);
     const int slashIndex = path.lastIndexOf('/');
     if (slashIndex == -1)
-        return path;
+        return {};
     return path.left(slashIndex);
 }