Merge pull request #14466 from glassez/sha1hash

Improve "info hash" handling

src/base/CMakeLists.txt

@@ -32,6 +32,7 @@ add_library(qbt_base STATIC
     bittorrent/torrentinfo.h
     bittorrent/tracker.h
     bittorrent/trackerentry.h
+    digest32.h
     exceptions.h
     filesystemwatcher.h
     global.h

src/base/base.pri

@@ -31,6 +31,7 @@ HEADERS += \
     $$PWD/bittorrent/torrentinfo.h \
     $$PWD/bittorrent/tracker.h \
     $$PWD/bittorrent/trackerentry.h \
+    $$PWD/digest32.h \
     $$PWD/exceptions.h \
     $$PWD/filesystemwatcher.h \
     $$PWD/global.h \

src/base/bittorrent/infohash.cpp

@@ -1,6 +1,6 @@
 /*
  * Bittorrent Client using Qt and libtorrent.
- * Copyright (C) 2015  Vladimir Golovnev <glassez@yandex.ru>
+ * Copyright (C) 2015, 2021  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
@@ -28,68 +28,14 @@
 
 #include "infohash.h"
 
-#include <QByteArray>
-#include <QHash>
+const int InfoHashTypeId = qRegisterMetaType<BitTorrent::InfoHash>();
 
-using namespace BitTorrent;
-
-const int InfoHashTypeId = qRegisterMetaType<InfoHash>();
-
-InfoHash::InfoHash(const lt::sha1_hash &nativeHash)
-    : m_valid(true)
-    , m_nativeHash(nativeHash)
+BitTorrent::InfoHash BitTorrent::InfoHash::fromString(const QString &hashString)
 {
-    const QByteArray raw = QByteArray::fromRawData(nativeHash.data(), length());
-    m_hashString = QString::fromLatin1(raw.toHex());
+    return {SHA1Hash::fromString(hashString)};
 }
 
-InfoHash::InfoHash(const QString &hashString)
-    : m_valid(false)
+uint BitTorrent::qHash(const BitTorrent::InfoHash &key, const uint seed)
 {
-    if (hashString.size() != (length() * 2))
-        return;
-
-    const QByteArray raw = QByteArray::fromHex(hashString.toLatin1());
-    if (raw.size() != length())  // QByteArray::fromHex() will skip over invalid characters
-        return;
-
-    m_valid = true;
-    m_hashString = hashString;
-    m_nativeHash.assign(raw.constData());
-}
-
-bool InfoHash::isValid() const
-{
-    return m_valid;
-}
-
-InfoHash::operator lt::sha1_hash() const
-{
-    return m_nativeHash;
-}
-
-InfoHash::operator QString() const
-{
-    return m_hashString;
-}
-
-bool BitTorrent::operator==(const InfoHash &left, const InfoHash &right)
-{
-    return (static_cast<lt::sha1_hash>(left)
-            == static_cast<lt::sha1_hash>(right));
-}
-
-bool BitTorrent::operator!=(const InfoHash &left, const InfoHash &right)
-{
-    return !(left == right);
-}
-
-bool BitTorrent::operator<(const InfoHash &left, const InfoHash &right)
-{
-    return static_cast<lt::sha1_hash>(left) < static_cast<lt::sha1_hash>(right);
-}
-
-uint BitTorrent::qHash(const InfoHash &key, const uint seed)
-{
-    return ::qHash((std::hash<lt::sha1_hash> {})(key), seed);
+    return ::qHash(std::hash<InfoHash::UnderlyingType>()(key), seed);
 }

src/base/bittorrent/infohash.h

@@ -1,6 +1,6 @@
 /*
  * Bittorrent Client using Qt and libtorrent.
- * Copyright (C) 2015  Vladimir Golovnev <glassez@yandex.ru>
+ * Copyright (C) 2015, 2021  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
@@ -28,41 +28,25 @@
 
 #pragma once
 
-#include <libtorrent/sha1_hash.hpp>
-
+#include <QHash>
 #include <QMetaType>
-#include <QString>
+
+#include "base/digest32.h"
+
+using SHA1Hash = Digest32<160>;
+using SHA256Hash = Digest32<256>;
 
 namespace BitTorrent
 {
-    class InfoHash
+    class InfoHash : public SHA1Hash
     {
     public:
-        InfoHash() = default;
-        InfoHash(const lt::sha1_hash &nativeHash);
-        InfoHash(const QString &hashString);
-        InfoHash(const InfoHash &other) = default;
+        using SHA1Hash::SHA1Hash;
 
-        static constexpr int length()
-        {
-            return lt::sha1_hash::size();
-        }
-
-        bool isValid() const;
-
-        operator lt::sha1_hash() const;
-        operator QString() const;
-
-    private:
-        bool m_valid = false;
-        lt::sha1_hash m_nativeHash;
-        QString m_hashString;
+        static InfoHash fromString(const QString &hashString);
     };
 
-    bool operator==(const InfoHash &left, const InfoHash &right);
-    bool operator!=(const InfoHash &left, const InfoHash &right);
-    bool operator<(const InfoHash &left, const InfoHash &right);
-    uint qHash(const InfoHash &key, uint seed);
+    uint qHash(const InfoHash &key, const uint seed);
 }
 
 Q_DECLARE_METATYPE(BitTorrent::InfoHash)

src/base/bittorrent/magneturi.cpp

@@ -40,7 +40,7 @@
 
 namespace
 {
-    bool isBitTorrentInfoHash(const QString &string)
+    bool isSHA1Hash(const QString &string)
     {
         // There are 2 representations for BitTorrent info hash:
         // 1. 40 chars hex-encoded string
@@ -65,7 +65,7 @@ MagnetUri::MagnetUri(const QString &source)
 {
     if (source.isEmpty()) return;
 
-    if (isBitTorrentInfoHash(source))
+    if (isSHA1Hash(source))
         m_url = QLatin1String("magnet:?xt=urn:btih:") + source;
 
     lt::error_code ec;

src/base/bittorrent/session.cpp

@@ -1798,7 +1798,7 @@ bool Session::deleteTorrent(const InfoHash &hash, const DeleteOption deleteOptio
     TorrentImpl *const torrent = m_torrents.take(hash);
     if (!torrent) return false;
 
-    qDebug("Deleting torrent with hash: %s", qUtf8Printable(torrent->hash()));
+    qDebug("Deleting torrent with hash: %s", qUtf8Printable(torrent->hash().toString()));
     emit torrentAboutToBeRemoved(torrent);
 
     // Remove it from session
@@ -1852,8 +1852,8 @@ bool Session::deleteTorrent(const InfoHash &hash, const DeleteOption deleteOptio
     }
 
     // Remove it from torrent resume directory
-    const QString resumedataFile = QString::fromLatin1("%1.fastresume").arg(torrent->hash());
-    const QString metadataFile = QString::fromLatin1("%1.torrent").arg(torrent->hash());
+    const QString resumedataFile = QString::fromLatin1("%1.fastresume").arg(torrent->hash().toString());
+    const QString metadataFile = QString::fromLatin1("%1.torrent").arg(torrent->hash().toString());
 #if (QT_VERSION >= QT_VERSION_CHECK(5, 10, 0))
     QMetaObject::invokeMethod(m_resumeDataSavingManager, [this, resumedataFile, metadataFile]()
     {
@@ -2250,7 +2250,7 @@ bool Session::downloadMetadata(const MagnetUri &magnetUri)
     if (m_downloadedMetadata.contains(hash)) return false;
 
     qDebug("Adding torrent to preload metadata...");
-    qDebug(" -> Hash: %s", qUtf8Printable(hash));
+    qDebug(" -> Hash: %s", qUtf8Printable(hash.toString()));
     qDebug(" -> Name: %s", qUtf8Printable(name));
 
     lt::add_torrent_params p = magnetUri.addTorrentParams();
@@ -2266,7 +2266,7 @@ bool Session::downloadMetadata(const MagnetUri &magnetUri)
     p.max_connections = maxConnectionsPerTorrent();
     p.max_uploads = maxUploadsPerTorrent();
 
-    const QString savePath = Utils::Fs::tempPath() + static_cast<QString>(hash);
+    const QString savePath = Utils::Fs::tempPath() + hash.toString();
     p.save_path = Utils::Fs::toNativePath(savePath).toStdString();
 
     // Forced start
@@ -2299,7 +2299,7 @@ void Session::exportTorrentFile(const Torrent *torrent, TorrentExportFolder fold
              ((folder == TorrentExportFolder::Finished) && !finishedTorrentExportDirectory().isEmpty()));
 
     const QString validName = Utils::Fs::toValidFileSystemName(torrent->name());
-    const QString torrentFilename = QString::fromLatin1("%1.torrent").arg(torrent->hash());
+    const QString torrentFilename = QString::fromLatin1("%1.torrent").arg(torrent->hash().toString());
     QString torrentExportFilename = QString::fromLatin1("%1.torrent").arg(validName);
     const QString torrentPath = QDir(m_resumeFolderPath).absoluteFilePath(torrentFilename);
     const QDir exportPath(folder == TorrentExportFolder::Regular ? torrentExportDirectory() : finishedTorrentExportDirectory());
@@ -2372,7 +2372,7 @@ void Session::saveTorrentsQueue() const
         // We require actual (non-cached) queue position here!
         const int queuePos = static_cast<LTUnderlyingType<lt::queue_position_t>>(torrent->nativeHandle().queue_position());
         if (queuePos >= 0)
-            queue[queuePos] = torrent->hash();
+            queue[queuePos] = torrent->hash().toString();
     }
 
     QByteArray data;
@@ -3852,7 +3852,7 @@ void Session::handleTorrentMetadataReceived(TorrentImpl *const torrent)
 {
     // Save metadata
     const QDir resumeDataDir {m_resumeFolderPath};
-    const QString torrentFileName {QString {"%1.torrent"}.arg(torrent->hash())};
+    const QString torrentFileName {QString {"%1.torrent"}.arg(torrent->hash().toString())};
     try
     {
         torrent->info().saveToFile(resumeDataDir.absoluteFilePath(torrentFileName));
@@ -3932,7 +3932,7 @@ void Session::handleTorrentResumeDataReady(TorrentImpl *const torrent, const std
     // Separated thread is used for the blocking IO which results in slow processing of many torrents.
     // Copying lt::entry objects around isn't cheap.
 
-    const QString filename = QString::fromLatin1("%1.fastresume").arg(torrent->hash());
+    const QString filename = QString::fromLatin1("%1.fastresume").arg(torrent->hash().toString());
 #if (QT_VERSION >= QT_VERSION_CHECK(5, 10, 0))
     QMetaObject::invokeMethod(m_resumeDataSavingManager
         , [this, filename, data]() { m_resumeDataSavingManager->save(filename, data); });
@@ -4010,7 +4010,7 @@ void Session::moveTorrentStorage(const MoveStorageJob &job) const
 {
     const InfoHash infoHash = job.torrentHandle.info_hash();
     const TorrentImpl *torrent = m_torrents.value(infoHash);
-    const QString torrentName = (torrent ? torrent->name() : QString {infoHash});
+    const QString torrentName = (torrent ? torrent->name() : infoHash.toString());
     LogMsg(tr("Moving \"%1\" to \"%2\"...").arg(torrentName, job.path));
 
     job.torrentHandle.move_storage(job.path.toUtf8().constData()
@@ -4583,7 +4583,7 @@ void Session::createTorrent(const lt::torrent_handle &nativeHandle)
         {
             // Backup torrent file
             const QDir resumeDataDir {m_resumeFolderPath};
-            const QString torrentFileName {QString {"%1.torrent"}.arg(torrent->hash())};
+            const QString torrentFileName {QString::fromLatin1("%1.torrent").arg(torrent->hash().toString())};
             try
             {
                 torrent->info().saveToFile(resumeDataDir.absoluteFilePath(torrentFileName));
@@ -4921,7 +4921,7 @@ void Session::handleStorageMovedAlert(const lt::storage_moved_alert *p)
 
     const InfoHash infoHash = currentJob.torrentHandle.info_hash();
     TorrentImpl *torrent = m_torrents.value(infoHash);
-    const QString torrentName = (torrent ? torrent->name() : QString {infoHash});
+    const QString torrentName = (torrent ? torrent->name() : infoHash.toString());
     LogMsg(tr("\"%1\" is successfully moved to \"%2\".").arg(torrentName, newPath));
 
     handleMoveTorrentStorageJobFinished();
@@ -4936,7 +4936,7 @@ void Session::handleStorageMovedFailedAlert(const lt::storage_moved_failed_alert
 
     const InfoHash infoHash = currentJob.torrentHandle.info_hash();
     TorrentImpl *torrent = m_torrents.value(infoHash);
-    const QString torrentName = (torrent ? torrent->name() : QString {infoHash});
+    const QString torrentName = (torrent ? torrent->name() : infoHash.toString());
     const QString currentLocation = QString::fromStdString(p->handle.status(lt::torrent_handle::query_save_path).save_path);
     const QString errorMessage = QString::fromStdString(p->message());
     LogMsg(tr("Failed to move \"%1\" from \"%2\" to \"%3\". Reason: %4.")

src/base/bittorrent/torrentimpl.cpp

@@ -185,7 +185,7 @@ QString TorrentImpl::name() const
     if (!name.isEmpty())
         return name;
 
-    return m_hash;
+    return m_hash.toString();
 }
 
 QDateTime TorrentImpl::creationDate() const

src/base/bittorrent/tracker.cpp

@@ -295,7 +295,7 @@ void Tracker::processAnnounceRequest()
     if (infoHashIter == queryParams.end())
         throw TrackerError("Missing \"info_hash\" parameter");
 
-    const InfoHash infoHash(infoHashIter->toHex());
+    const auto infoHash = InfoHash::fromString(infoHashIter->toHex());
     if (!infoHash.isValid())
         throw TrackerError("Invalid \"info_hash\" parameter");
 

src/base/digest32.h

@@ -0,0 +1,121 @@
+/*
+ * Bittorrent Client using Qt and libtorrent.
+ * Copyright (C) 2015, 2021  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 <libtorrent/sha1_hash.hpp>
+
+#include <QByteArray>
+#include <QHash>
+#include <QString>
+
+template <int N>
+class Digest32
+{
+public:
+    using UnderlyingType = lt::digest32<N>;
+
+    Digest32() = default;
+    Digest32(const Digest32 &other) = default;
+
+    Digest32(const UnderlyingType &nativeDigest)
+        : m_valid {true}
+        , m_nativeDigest {nativeDigest}
+    {
+        const QByteArray raw = QByteArray::fromRawData(nativeDigest.data(), length());
+        m_hashString = QString::fromLatin1(raw.toHex());
+    }
+
+    static constexpr int length()
+    {
+        return UnderlyingType::size();
+    }
+
+    bool isValid() const
+    {
+        return m_valid;
+    }
+
+    operator UnderlyingType() const
+    {
+        return m_nativeDigest;
+    }
+
+    static Digest32 fromString(const QString &digestString)
+    {
+        if (digestString.size() != (length() * 2))
+            return {};
+
+        const QByteArray raw = QByteArray::fromHex(digestString.toLatin1());
+        if (raw.size() != length())  // QByteArray::fromHex() will skip over invalid characters
+            return {};
+
+        Digest32 result;
+        result.m_valid = true;
+        result.m_hashString = digestString;
+        result.m_nativeDigest.assign(raw.constData());
+
+        return result;
+    }
+
+    QString toString() const
+    {
+        return m_hashString;
+    }
+
+private:
+    bool m_valid = false;
+    UnderlyingType m_nativeDigest;
+    QString m_hashString;
+};
+
+template <int N>
+bool operator==(const Digest32<N> &left, const Digest32<N> &right)
+{
+    return (static_cast<typename Digest32<N>::UnderlyingType>(left)
+            == static_cast<typename Digest32<N>::UnderlyingType>(right));
+}
+
+template <int N>
+bool operator!=(const Digest32<N> &left, const Digest32<N> &right)
+{
+    return !(left == right);
+}
+
+template <int N>
+bool operator<(const Digest32<N> &left, const Digest32<N> &right)
+{
+    return static_cast<typename Digest32<N>::UnderlyingType>(left)
+            < static_cast<typename Digest32<N>::UnderlyingType>(right);
+}
+
+template <int N>
+uint qHash(const Digest32<N> &key, const uint seed)
+{
+    return ::qHash(std::hash<typename Digest32<N>::UnderlyingType>()(key), seed);
+}