BitTorrent::BencodeResumeDataStorage Class Reference

#include <bencoderesumedatastorage.h>

Inheritance diagram for BitTorrent::BencodeResumeDataStorage:

Collaboration diagram for BitTorrent::BencodeResumeDataStorage:

Classes
class	Worker

Public Member Functions
	BencodeResumeDataStorage (const QString &path, QObject *parent=nullptr)
	~BencodeResumeDataStorage () override
QVector< TorrentID >	registeredTorrents () const override
std::optional< LoadTorrentParams >	load (const TorrentID &id) const override
void	store (const TorrentID &id, const LoadTorrentParams &resumeData) const override
void	remove (const TorrentID &id) const override
void	storeQueue (const QVector< TorrentID > &queue) const override

Private Member Functions
void	loadQueue (const QString &queueFilename)
std::optional< LoadTorrentParams >	loadTorrentResumeData (const QByteArray &data, const QByteArray &metadata) const

Private Attributes
const QDir	m_resumeDataDir
QVector< TorrentID >	m_registeredTorrents
QThread *	m_ioThread = nullptr
Worker *	m_asyncWorker = nullptr

Detailed Description

Definition at line 41 of file bencoderesumedatastorage.h.

Constructor & Destructor Documentation

BencodeResumeDataStorage()

BitTorrent::BencodeResumeDataStorage::BencodeResumeDataStorage ( const QString &  path, QObject *  parent = nullptr  )

explicit

Definition at line 92 of file bencoderesumedatastorage.cpp.

    : ResumeDataStorage {parent}
    , m_resumeDataDir {path}
    , m_ioThread {new QThread {this}}
    , m_asyncWorker {new Worker {m_resumeDataDir}}
{
    if (!m_resumeDataDir.exists() && !m_resumeDataDir.mkpath(m_resumeDataDir.absolutePath()))
    {
        throw RuntimeError {tr("Cannot create torrent resume folder: \"%1\"")
                    .arg(Utils::Fs::toNativePath(m_resumeDataDir.absolutePath()))};
    }
 
    const QRegularExpression filenamePattern {QLatin1String("^([A-Fa-f0-9]{40})\\.fastresume$")};
    const QStringList filenames = m_resumeDataDir.entryList(QStringList(QLatin1String("*.fastresume")), QDir::Files, QDir::Unsorted);
 
    m_registeredTorrents.reserve(filenames.size());
    for (const QString &filename : filenames)
    {
         const QRegularExpressionMatch rxMatch = filenamePattern.match(filename);
         if (rxMatch.hasMatch())
             m_registeredTorrents.append(TorrentID::fromString(rxMatch.captured(1)));
    }
 
    loadQueue(m_resumeDataDir.absoluteFilePath(QLatin1String("queue")));
 
    qDebug() << "Registered torrents count: " << m_registeredTorrents.size();
 
    m_asyncWorker->moveToThread(m_ioThread);
    connect(m_ioThread, &QThread::finished, m_asyncWorker, &QObject::deleteLater);
    m_ioThread->start();
}

References BitTorrent::TorrentID::fromString(), loadQueue(), m_asyncWorker, m_ioThread, m_registeredTorrents, m_resumeDataDir, and Utils::Fs::toNativePath().

Here is the call graph for this function:

~BencodeResumeDataStorage()

BitTorrent::BencodeResumeDataStorage::~BencodeResumeDataStorage ( )

override

Definition at line 124 of file bencoderesumedatastorage.cpp.

{
    m_ioThread->quit();
    m_ioThread->wait();
}

Member Function Documentation

load()

std::optional< BitTorrent::LoadTorrentParams > BitTorrent::BencodeResumeDataStorage::load ( const TorrentID &  id ) const

overridevirtual

Implements BitTorrent::ResumeDataStorage.

Definition at line 135 of file bencoderesumedatastorage.cpp.

{
    const QString idString = id.toString();
    const QString fastresumePath = m_resumeDataDir.absoluteFilePath(QString::fromLatin1("%1.fastresume").arg(idString));
    const QString torrentFilePath = m_resumeDataDir.absoluteFilePath(QString::fromLatin1("%1.torrent").arg(idString));
 
    QFile resumeDataFile {fastresumePath};
    if (!resumeDataFile.open(QIODevice::ReadOnly))
    {
        LogMsg(tr("Cannot read file %1: %2").arg(fastresumePath, resumeDataFile.errorString()), Log::WARNING);
        return std::nullopt;
    }
 
    QFile metadataFile {torrentFilePath};
    if (metadataFile.exists() && !metadataFile.open(QIODevice::ReadOnly))
    {
        LogMsg(tr("Cannot read file %1: %2").arg(torrentFilePath, metadataFile.errorString()), Log::WARNING);
        return std::nullopt;
    }
 
    const QByteArray data = resumeDataFile.readAll();
    const QByteArray metadata = (metadataFile.isOpen() ? metadataFile.readAll() : "");
 
    return loadTorrentResumeData(data, metadata);
}

References LogMsg(), and Log::WARNING.

Here is the call graph for this function:

loadQueue()

void BitTorrent::BencodeResumeDataStorage::loadQueue ( const QString &  queueFilename )

private

Definition at line 276 of file bencoderesumedatastorage.cpp.

{
    QFile queueFile {queueFilename};
    if (!queueFile.exists())
        return;
 
    if (queueFile.open(QFile::ReadOnly))
    {
        const QRegularExpression hashPattern {QLatin1String("^([A-Fa-f0-9]{40})$")};
        QByteArray line;
        int start = 0;
        while (!(line = queueFile.readLine().trimmed()).isEmpty())
        {
            const QRegularExpressionMatch rxMatch = hashPattern.match(line);
            if (rxMatch.hasMatch())
            {
                const auto torrentID = TorrentID::fromString(rxMatch.captured(1));
                const int pos = m_registeredTorrents.indexOf(torrentID, start);
                if (pos != -1)
                {
                    std::swap(m_registeredTorrents[start], m_registeredTorrents[pos]);
                    ++start;
                }
            }
        }
    }
    else
    {
        LogMsg(tr("Couldn't load torrents queue from '%1'. Error: %2")
               .arg(queueFile.fileName(), queueFile.errorString()), Log::WARNING);
    }
}

References BitTorrent::TorrentID::fromString(), LogMsg(), and Log::WARNING.

Referenced by BencodeResumeDataStorage().

Here is the call graph for this function:

Here is the caller graph for this function:

loadTorrentResumeData()

std::optional< BitTorrent::LoadTorrentParams > BitTorrent::BencodeResumeDataStorage::loadTorrentResumeData ( const QByteArray &  data, const QByteArray &  metadata  ) const

private

Definition at line 161 of file bencoderesumedatastorage.cpp.

{
    const QByteArray allData = ((metadata.isEmpty() || data.isEmpty())
                                ? data : (data.chopped(1) + metadata.mid(1)));
 
    lt::error_code ec;
    const lt::bdecode_node root = lt::bdecode(allData, ec);
    if (ec || (root.type() != lt::bdecode_node::dict_t))
        return std::nullopt;
 
    LoadTorrentParams torrentParams;
    torrentParams.restored = true;
    torrentParams.category = fromLTString(root.dict_find_string_value("qBt-category"));
    torrentParams.name = fromLTString(root.dict_find_string_value("qBt-name"));
    torrentParams.hasSeedStatus = root.dict_find_int_value("qBt-seedStatus");
    torrentParams.firstLastPiecePriority = root.dict_find_int_value("qBt-firstLastPiecePriority");
    torrentParams.seedingTimeLimit = root.dict_find_int_value("qBt-seedingTimeLimit", Torrent::USE_GLOBAL_SEEDING_TIME);
 
    torrentParams.savePath = Profile::instance()->fromPortablePath(
                Utils::Fs::toUniformPath(fromLTString(root.dict_find_string_value("qBt-savePath"))));
    torrentParams.useAutoTMM = torrentParams.savePath.isEmpty();
    if (!torrentParams.useAutoTMM)
    {
        torrentParams.downloadPath = Profile::instance()->fromPortablePath(
                    Utils::Fs::toUniformPath(fromLTString(root.dict_find_string_value("qBt-downloadPath"))));
    }
 
    // TODO: The following code is deprecated. Replace with the commented one after several releases in 4.4.x.
    // === BEGIN DEPRECATED CODE === //
    const lt::bdecode_node contentLayoutNode = root.dict_find("qBt-contentLayout");
    if (contentLayoutNode.type() == lt::bdecode_node::string_t)
    {
        const QString contentLayoutStr = fromLTString(contentLayoutNode.string_value());
        torrentParams.contentLayout = Utils::String::toEnum(contentLayoutStr, TorrentContentLayout::Original);
    }
    else
    {
        const bool hasRootFolder = root.dict_find_int_value("qBt-hasRootFolder");
        torrentParams.contentLayout = (hasRootFolder ? TorrentContentLayout::Original : TorrentContentLayout::NoSubfolder);
    }
    // === END DEPRECATED CODE === //
    // === BEGIN REPLACEMENT CODE === //
    //    torrentParams.contentLayout = Utils::String::parse(
    //                fromLTString(root.dict_find_string_value("qBt-contentLayout")), TorrentContentLayout::Default);
    // === END REPLACEMENT CODE === //
 
    const lt::string_view ratioLimitString = root.dict_find_string_value("qBt-ratioLimit");
    if (ratioLimitString.empty())
        torrentParams.ratioLimit = root.dict_find_int_value("qBt-ratioLimit", Torrent::USE_GLOBAL_RATIO * 1000) / 1000.0;
    else
        torrentParams.ratioLimit = fromLTString(ratioLimitString).toDouble();
 
    const lt::bdecode_node tagsNode = root.dict_find("qBt-tags");
    if (tagsNode.type() == lt::bdecode_node::list_t)
    {
        for (int i = 0; i < tagsNode.list_size(); ++i)
        {
            const QString tag = fromLTString(tagsNode.list_string_value_at(i));
            torrentParams.tags.insert(tag);
        }
    }
 
    lt::add_torrent_params &p = torrentParams.ltAddTorrentParams;
 
    p = lt::read_resume_data(root, ec);
    p.save_path = Profile::instance()->fromPortablePath(fromLTString(p.save_path)).toStdString();
 
    if (p.flags & lt::torrent_flags::stop_when_ready)
    {
        // If torrent has "stop_when_ready" flag set then it is actually "stopped"
        torrentParams.stopped = true;
        torrentParams.operatingMode = TorrentOperatingMode::AutoManaged;
        // ...but temporarily "resumed" to perform some service jobs (e.g. checking)
        p.flags &= ~lt::torrent_flags::paused;
        p.flags |= lt::torrent_flags::auto_managed;
    }
    else
    {
        torrentParams.stopped = (p.flags & lt::torrent_flags::paused) && !(p.flags & lt::torrent_flags::auto_managed);
        torrentParams.operatingMode = (p.flags & lt::torrent_flags::paused) || (p.flags & lt::torrent_flags::auto_managed)
                ? TorrentOperatingMode::AutoManaged : TorrentOperatingMode::Forced;
    }
 
    const bool hasMetadata = (p.ti && p.ti->is_valid());
    if (!hasMetadata && !root.dict_find("info-hash"))
        return std::nullopt;
 
    return torrentParams;
}

References BitTorrent::LoadTorrentParams::category, BitTorrent::LoadTorrentParams::contentLayout, BitTorrent::LoadTorrentParams::downloadPath, BitTorrent::LoadTorrentParams::firstLastPiecePriority, anonymous_namespace{bencoderesumedatastorage.cpp}::fromLTString(), Profile::fromPortablePath(), BitTorrent::LoadTorrentParams::hasSeedStatus, Profile::instance(), BitTorrent::LoadTorrentParams::ltAddTorrentParams, BitTorrent::LoadTorrentParams::name, BitTorrent::LoadTorrentParams::operatingMode, BitTorrent::LoadTorrentParams::ratioLimit, BitTorrent::LoadTorrentParams::restored, BitTorrent::LoadTorrentParams::savePath, BitTorrent::LoadTorrentParams::seedingTimeLimit, BitTorrent::LoadTorrentParams::stopped, BitTorrent::LoadTorrentParams::tags, Utils::String::toEnum(), Utils::Fs::toUniformPath(), BitTorrent::Torrent::USE_GLOBAL_RATIO, BitTorrent::Torrent::USE_GLOBAL_SEEDING_TIME, and BitTorrent::LoadTorrentParams::useAutoTMM.

Here is the call graph for this function:

registeredTorrents()

QVector< BitTorrent::TorrentID > BitTorrent::BencodeResumeDataStorage::registeredTorrents ( ) const

overridevirtual

Implements BitTorrent::ResumeDataStorage.

Definition at line 130 of file bencoderesumedatastorage.cpp.

{
    return m_registeredTorrents;
}

remove()

void BitTorrent::BencodeResumeDataStorage::remove ( const TorrentID &  id ) const

overridevirtual

Implements BitTorrent::ResumeDataStorage.

Definition at line 260 of file bencoderesumedatastorage.cpp.

{
    QMetaObject::invokeMethod(m_asyncWorker, [this, id]()
    {
        m_asyncWorker->remove(id);
    });
}

store()

void BitTorrent::BencodeResumeDataStorage::store ( const TorrentID &  id, const LoadTorrentParams &  resumeData  ) const

overridevirtual

Implements BitTorrent::ResumeDataStorage.

Definition at line 252 of file bencoderesumedatastorage.cpp.

{
    QMetaObject::invokeMethod(m_asyncWorker, [this, id, resumeData]()
    {
        m_asyncWorker->store(id, resumeData);
    });
}

storeQueue()

void BitTorrent::BencodeResumeDataStorage::storeQueue ( const QVector< TorrentID > &  queue ) const

overridevirtual

Implements BitTorrent::ResumeDataStorage.

Definition at line 268 of file bencoderesumedatastorage.cpp.

{
    QMetaObject::invokeMethod(m_asyncWorker, [this, queue]()
    {
        m_asyncWorker->storeQueue(queue);
    });
}

Member Data Documentation

m_asyncWorker

Worker* BitTorrent::BencodeResumeDataStorage::m_asyncWorker = nullptr

private

Definition at line 65 of file bencoderesumedatastorage.h.

Referenced by BencodeResumeDataStorage().

m_ioThread

QThread* BitTorrent::BencodeResumeDataStorage::m_ioThread = nullptr

private

Definition at line 62 of file bencoderesumedatastorage.h.

Referenced by BencodeResumeDataStorage().

m_registeredTorrents

QVector<TorrentID> BitTorrent::BencodeResumeDataStorage::m_registeredTorrents

private

Definition at line 61 of file bencoderesumedatastorage.h.

Referenced by BencodeResumeDataStorage().

m_resumeDataDir

const QDir BitTorrent::BencodeResumeDataStorage::m_resumeDataDir

private

Definition at line 60 of file bencoderesumedatastorage.h.

Referenced by BencodeResumeDataStorage(), BitTorrent::BencodeResumeDataStorage::Worker::remove(), BitTorrent::BencodeResumeDataStorage::Worker::store(), and BitTorrent::BencodeResumeDataStorage::Worker::storeQueue().

---

The documentation for this class was generated from the following files:

• src/base/bittorrent/bencoderesumedatastorage.h
• src/base/bittorrent/bencoderesumedatastorage.cpp