RSS::AutoDownloader Class Reference

#include <rss_autodownloader.h>

Inheritance diagram for RSS::AutoDownloader:

Collaboration diagram for RSS::AutoDownloader:

Public Types
enum class	RulesFileFormat { Legacy , JSON }

Signals
void	processingStateChanged (bool enabled)
void	ruleAdded (const QString &ruleName)
void	ruleChanged (const QString &ruleName)
void	ruleRenamed (const QString &ruleName, const QString &oldRuleName)
void	ruleAboutToBeRemoved (const QString &ruleName)

Public Member Functions
bool	isProcessingEnabled () const
void	setProcessingEnabled (bool enabled)
QStringList	smartEpisodeFilters () const
void	setSmartEpisodeFilters (const QStringList &filters)
QRegularExpression	smartEpisodeRegex () const
bool	downloadRepacks () const
void	setDownloadRepacks (bool enabled)
bool	hasRule (const QString &ruleName) const
AutoDownloadRule	ruleByName (const QString &ruleName) const
QList< AutoDownloadRule >	rules () const
void	insertRule (const AutoDownloadRule &rule)
bool	renameRule (const QString &ruleName, const QString &newRuleName)
void	removeRule (const QString &ruleName)
QByteArray	exportRules (RulesFileFormat format=RulesFileFormat::JSON) const
void	importRules (const QByteArray &data, RulesFileFormat format=RulesFileFormat::JSON)

Static Public Member Functions
static AutoDownloader *	instance ()

Private Slots
void	process ()
void	handleTorrentDownloadFinished (const QString &url)
void	handleTorrentDownloadFailed (const QString &url)
void	handleNewArticle (const Article *article)

Private Member Functions
	AutoDownloader ()
	~AutoDownloader () override
void	timerEvent (QTimerEvent *event) override
void	setRule_impl (const AutoDownloadRule &rule)
void	resetProcessingQueue ()
void	startProcessing ()
void	addJobForArticle (const Article *article)
void	processJob (const QSharedPointer< ProcessingJob > &job)
void	load ()
void	loadRules (const QByteArray &data)
void	loadRulesLegacy ()
void	store ()
void	storeDeferred ()
QByteArray	exportRulesToJSONFormat () const
void	importRulesFromJSONFormat (const QByteArray &data)
QByteArray	exportRulesToLegacyFormat () const
void	importRulesFromLegacyFormat (const QByteArray &data)

Private Attributes
CachedSettingValue< bool >	m_storeProcessingEnabled
SettingValue< QVariant >	m_storeSmartEpisodeFilter
SettingValue< bool >	m_storeDownloadRepacks
QTimer *	m_processingTimer
QThread *	m_ioThread
AsyncFileStorage *	m_fileStorage
QHash< QString, AutoDownloadRule >	m_rules
QList< QSharedPointer< ProcessingJob > >	m_processingQueue
QHash< QString, QSharedPointer< ProcessingJob > >	m_waitingJobs
bool	m_dirty = false
QBasicTimer	m_savingTimer
QRegularExpression	m_smartEpisodeRegex

Static Private Attributes
static QPointer< AutoDownloader >	m_instance = nullptr

Friends
class	::Application

Detailed Description

Definition at line 63 of file rss_autodownloader.h.

Member Enumeration Documentation

RulesFileFormat

enum RSS::AutoDownloader::RulesFileFormat

strong

Enumerator
Legacy
JSON

Definition at line 74 of file rss_autodownloader.h.

        {
            Legacy,
            JSON
        };

Constructor & Destructor Documentation

AutoDownloader()

AutoDownloader::AutoDownloader ( )

private

Definition at line 100 of file rss_autodownloader.cpp.

    : m_storeProcessingEnabled("RSS/AutoDownloader/EnableProcessing", false)
    , m_storeSmartEpisodeFilter("RSS/AutoDownloader/SmartEpisodeFilter")
    , m_storeDownloadRepacks("RSS/AutoDownloader/DownloadRepacks")
    , m_processingTimer(new QTimer(this))
    , m_ioThread(new QThread(this))
{
    Q_ASSERT(!m_instance); // only one instance is allowed
    m_instance = this;
 
    m_fileStorage = new AsyncFileStorage(
                Utils::Fs::expandPathAbs(specialFolderLocation(SpecialFolder::Config) + QLatin1Char('/') + ConfFolderName));
    if (!m_fileStorage)
        throw RuntimeError(tr("Directory for RSS AutoDownloader data is unavailable."));
 
    m_fileStorage->moveToThread(m_ioThread);
    connect(m_ioThread, &QThread::finished, m_fileStorage, &AsyncFileStorage::deleteLater);
    connect(m_fileStorage, &AsyncFileStorage::failed, [](const QString &fileName, const QString &errorString)
    {
        LogMsg(tr("Couldn't save RSS AutoDownloader data in %1. Error: %2")
               .arg(fileName, errorString), Log::CRITICAL);
    });
 
    m_ioThread->start();
 
    connect(BitTorrent::Session::instance(), &BitTorrent::Session::downloadFromUrlFinished
            , this, &AutoDownloader::handleTorrentDownloadFinished);
    connect(BitTorrent::Session::instance(), &BitTorrent::Session::downloadFromUrlFailed
            , this, &AutoDownloader::handleTorrentDownloadFailed);
 
    // initialise the smart episode regex
    const QString regex = computeSmartFilterRegex(smartEpisodeFilters());
    m_smartEpisodeRegex = QRegularExpression(regex,
                                             QRegularExpression::CaseInsensitiveOption
                                             | QRegularExpression::ExtendedPatternSyntaxOption
                                             | QRegularExpression::UseUnicodePropertiesOption);
 
    load();
 
    m_processingTimer->setSingleShot(true);
    connect(m_processingTimer, &QTimer::timeout, this, &AutoDownloader::process);
 
    if (isProcessingEnabled())
        startProcessing();
}

References computeSmartFilterRegex(), ConfFolderName(), Config, Log::CRITICAL, BitTorrent::Session::downloadFromUrlFailed(), BitTorrent::Session::downloadFromUrlFinished(), Utils::Fs::expandPathAbs(), AsyncFileStorage::failed(), Utils::Fs::fileName(), handleTorrentDownloadFailed(), handleTorrentDownloadFinished(), BitTorrent::Session::instance(), isProcessingEnabled(), load(), LogMsg(), m_fileStorage, m_instance, m_ioThread, m_processingTimer, m_smartEpisodeRegex, process(), smartEpisodeFilters(), specialFolderLocation(), and startProcessing().

Here is the call graph for this function:

~AutoDownloader()

AutoDownloader::~AutoDownloader ( )

overrideprivate

Definition at line 146 of file rss_autodownloader.cpp.

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

References m_ioThread, and store().

Here is the call graph for this function:

Member Function Documentation

addJobForArticle()

void AutoDownloader::addJobForArticle ( const Article *  article )

private

Definition at line 363 of file rss_autodownloader.cpp.

{
    const QString torrentURL = article->torrentUrl();
    if (m_waitingJobs.contains(torrentURL)) return;
 
    QSharedPointer<ProcessingJob> job(new ProcessingJob);
    job->feedURL = article->feed()->url();
    job->articleData = article->data();
    m_processingQueue.append(job);
    if (!m_processingTimer->isActive())
        m_processingTimer->start();
}

References RSS::Article::data(), RSS::Article::feed(), m_processingQueue, m_processingTimer, m_waitingJobs, RSS::Article::torrentUrl(), and RSS::Feed::url().

Referenced by handleNewArticle(), and resetProcessingQueue().

Here is the call graph for this function:

Here is the caller graph for this function:

downloadRepacks()

bool AutoDownloader::downloadRepacks

(

)

const

Definition at line 316 of file rss_autodownloader.cpp.

{
    return m_storeDownloadRepacks.get(true);
}

References SettingValue< T >::get(), and m_storeDownloadRepacks.

Referenced by OptionsDialog::loadOptions(), and AppController::preferencesAction().

Here is the call graph for this function:

Here is the caller graph for this function:

exportRules()

QByteArray AutoDownloader::exportRules

(

AutoDownloader::RulesFileFormat

format = RulesFileFormat::JSON

)

const

Definition at line 221 of file rss_autodownloader.cpp.

{
    switch (format)
    {
    case RulesFileFormat::Legacy:
        return exportRulesToLegacyFormat();
    default:
        return exportRulesToJSONFormat();
    }
}

References exportRulesToJSONFormat(), exportRulesToLegacyFormat(), and Legacy.

Referenced by AutomatedRssDownloader::on_exportBtn_clicked().

Here is the call graph for this function:

Here is the caller graph for this function:

exportRulesToJSONFormat()

QByteArray AutoDownloader::exportRulesToJSONFormat ( ) const

private

Definition at line 244 of file rss_autodownloader.cpp.

{
    QJsonObject jsonObj;
    for (const auto &rule : asConst(rules()))
        jsonObj.insert(rule.name(), rule.toJsonObject());
 
    return QJsonDocument(jsonObj).toJson();
}

References asConst(), and rules().

Referenced by exportRules().

Here is the call graph for this function:

Here is the caller graph for this function:

exportRulesToLegacyFormat()

QByteArray AutoDownloader::exportRulesToLegacyFormat ( ) const

private

Definition at line 259 of file rss_autodownloader.cpp.

{
    QVariantHash dict;
    for (const auto &rule : asConst(rules()))
        dict[rule.name()] = rule.toLegacyDict();
 
    QByteArray data;
    QDataStream out(&data, QIODevice::WriteOnly);
    out.setVersion(QDataStream::Qt_4_5);
    out << dict;
 
    return data;
}

References asConst(), and rules().

Referenced by exportRules().

Here is the call graph for this function:

Here is the caller graph for this function:

handleNewArticle

void AutoDownloader::handleNewArticle ( const Article *  article )

privateslot

Definition at line 352 of file rss_autodownloader.cpp.

{
    if (!article->isRead() && !article->torrentUrl().isEmpty())
        addJobForArticle(article);
}

References addJobForArticle(), RSS::Article::isRead(), and RSS::Article::torrentUrl().

Referenced by setProcessingEnabled(), and startProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

handleTorrentDownloadFailed

void AutoDownloader::handleTorrentDownloadFailed ( const QString &  url )

privateslot

Definition at line 346 of file rss_autodownloader.cpp.

{
    m_waitingJobs.remove(url);
    // TODO: Re-schedule job here.
}

References m_waitingJobs.

Referenced by AutoDownloader().

Here is the caller graph for this function:

handleTorrentDownloadFinished

void AutoDownloader::handleTorrentDownloadFinished ( const QString &  url )

privateslot

Definition at line 336 of file rss_autodownloader.cpp.

{
    const auto job = m_waitingJobs.take(url);
    if (!job) return;
 
    if (Feed *feed = Session::instance()->feedByURL(job->feedURL))
        if (Article *article = feed->articleByGUID(job->articleData.value(Article::KeyId).toString()))
            article->markAsRead();
}

References RSS::Session::instance(), RSS::Article::KeyId, and m_waitingJobs.

Referenced by AutoDownloader().

Here is the call graph for this function:

Here is the caller graph for this function:

hasRule()

bool AutoDownloader::hasRule

(

const QString &

ruleName

)

const

Definition at line 159 of file rss_autodownloader.cpp.

{
    return m_rules.contains(ruleName);
}

References m_rules.

Referenced by insertRule(), and renameRule().

Here is the caller graph for this function:

importRules()

void AutoDownloader::importRules	(	const QByteArray &	data,
		const AutoDownloader::RulesFileFormat	format = RulesFileFormat::JSON
	)

Definition at line 232 of file rss_autodownloader.cpp.

{
    switch (format)
    {
    case RulesFileFormat::Legacy:
        importRulesFromLegacyFormat(data);
        break;
    default:
        importRulesFromJSONFormat(data);
    }
}

References importRulesFromJSONFormat(), importRulesFromLegacyFormat(), and Legacy.

Referenced by AutomatedRssDownloader::on_importBtn_clicked().

Here is the call graph for this function:

Here is the caller graph for this function:

importRulesFromJSONFormat()

void AutoDownloader::importRulesFromJSONFormat ( const QByteArray &  data )

private

Definition at line 253 of file rss_autodownloader.cpp.

{
    for (const auto &rule : asConst(rulesFromJSON(data)))
        insertRule(rule);
}

References asConst(), insertRule(), and anonymous_namespace{rss_autodownloader.cpp}::rulesFromJSON().

Referenced by importRules().

Here is the call graph for this function:

Here is the caller graph for this function:

importRulesFromLegacyFormat()

void AutoDownloader::importRulesFromLegacyFormat ( const QByteArray &  data )

private

Definition at line 273 of file rss_autodownloader.cpp.

{
    QDataStream in(data);
    in.setVersion(QDataStream::Qt_4_5);
    QVariantHash dict;
    in >> dict;
    if (in.status() != QDataStream::Ok)
        throw ParsingError(tr("Invalid data format"));
 
    for (const QVariant &val : asConst(dict))
        insertRule(AutoDownloadRule::fromLegacyDict(val.toHash()));
}

References asConst(), RSS::AutoDownloadRule::fromLegacyDict(), and insertRule().

Referenced by importRules().

Here is the call graph for this function:

Here is the caller graph for this function:

insertRule()

void AutoDownloader::insertRule

(

const AutoDownloadRule &

rule

)

Definition at line 174 of file rss_autodownloader.cpp.

{
    if (!hasRule(rule.name()))
    {
        // Insert new rule
        setRule_impl(rule);
        m_dirty = true;
        store();
        emit ruleAdded(rule.name());
        resetProcessingQueue();
    }
    else if (ruleByName(rule.name()) != rule)
    {
        // Update existing rule
        setRule_impl(rule);
        m_dirty = true;
        storeDeferred();
        emit ruleChanged(rule.name());
        resetProcessingQueue();
    }
}

References hasRule(), m_dirty, RSS::AutoDownloadRule::name(), resetProcessingQueue(), ruleAdded(), ruleByName(), ruleChanged(), setRule_impl(), store(), and storeDeferred().

Referenced by AutomatedRssDownloader::handleFeedCheckStateChange(), importRulesFromJSONFormat(), importRulesFromLegacyFormat(), loadRulesLegacy(), AutomatedRssDownloader::on_addRuleBtn_clicked(), AutomatedRssDownloader::saveEditedRule(), and RSSController::setRuleAction().

Here is the call graph for this function:

Here is the caller graph for this function:

instance()

AutoDownloader * AutoDownloader::instance ( )

static

Definition at line 154 of file rss_autodownloader.cpp.

{
    return m_instance;
}

References m_instance.

Referenced by AutomatedRssDownloader::AutomatedRssDownloader(), Application::cleanup(), computeEpisodeName(), AutomatedRssDownloader::handleFeedCheckStateChange(), AutomatedRssDownloader::handleRuleChanged(), OptionsDialog::loadOptions(), RSS::AutoDownloadRule::matchesSmartEpisodeFilter(), RSSController::matchingArticlesAction(), AutomatedRssDownloader::on_addRuleBtn_clicked(), AutomatedRssDownloader::on_exportBtn_clicked(), AutomatedRssDownloader::on_importBtn_clicked(), AutomatedRssDownloader::on_removeRuleBtn_clicked(), AppController::preferencesAction(), RSSController::removeRuleAction(), RSSController::renameRuleAction(), AutomatedRssDownloader::renameSelectedRule(), RSSController::rulesAction(), AutomatedRssDownloader::saveEditedRule(), OptionsDialog::saveOptions(), AppController::setPreferencesAction(), RSSController::setRuleAction(), AutomatedRssDownloader::updateFeedList(), AutomatedRssDownloader::updateMatchingArticles(), and AutomatedRssDownloader::updateRuleDefinitionBox().

Here is the caller graph for this function:

isProcessingEnabled()

bool AutoDownloader::isProcessingEnabled

(

)

const

Definition at line 475 of file rss_autodownloader.cpp.

{
    return m_storeProcessingEnabled;
}

References m_storeProcessingEnabled.

Referenced by AutoDownloader(), OptionsDialog::loadOptions(), AppController::preferencesAction(), and resetProcessingQueue().

Here is the caller graph for this function:

load()

void AutoDownloader::load ( )

private

Definition at line 415 of file rss_autodownloader.cpp.

{
    QFile rulesFile(m_fileStorage->storageDir().absoluteFilePath(RulesFileName));
 
    if (!rulesFile.exists())
        loadRulesLegacy();
    else if (rulesFile.open(QFile::ReadOnly))
        loadRules(rulesFile.readAll());
    else
        LogMsg(tr("Couldn't read RSS AutoDownloader rules from %1. Error: %2")
               .arg(rulesFile.fileName(), rulesFile.errorString()), Log::CRITICAL);
}

References Log::CRITICAL, loadRules(), loadRulesLegacy(), LogMsg(), m_fileStorage, RulesFileName(), and AsyncFileStorage::storageDir().

Referenced by AutoDownloader().

Here is the call graph for this function:

Here is the caller graph for this function:

loadRules()

void AutoDownloader::loadRules ( const QByteArray &  data )

private

Definition at line 428 of file rss_autodownloader.cpp.

{
    try
    {
        const auto rules = rulesFromJSON(data);
        for (const auto &rule : rules)
            setRule_impl(rule);
    }
    catch (const ParsingError &error)
    {
        LogMsg(tr("Couldn't load RSS AutoDownloader rules. Reason: %1")
               .arg(error.message()), Log::CRITICAL);
    }
}

References Log::CRITICAL, LogMsg(), Exception::message(), rules(), anonymous_namespace{rss_autodownloader.cpp}::rulesFromJSON(), and setRule_impl().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

loadRulesLegacy()

void AutoDownloader::loadRulesLegacy ( )

private

Definition at line 443 of file rss_autodownloader.cpp.

{
    const SettingsPtr settings = Profile::instance()->applicationSettings(QStringLiteral("qBittorrent-rss"));
    const QVariantHash rules = settings->value(QStringLiteral("download_rules")).toHash();
    for (const QVariant &ruleVar : rules)
    {
        const auto rule = AutoDownloadRule::fromLegacyDict(ruleVar.toHash());
        if (!rule.name().isEmpty())
            insertRule(rule);
    }
}

References Profile::applicationSettings(), RSS::AutoDownloadRule::fromLegacyDict(), insertRule(), Profile::instance(), rules(), and anonymous_namespace{addnewtorrentdialog.cpp}::settings().

Referenced by load().

Here is the call graph for this function:

Here is the caller graph for this function:

process

void AutoDownloader::process ( )

privateslot

Definition at line 326 of file rss_autodownloader.cpp.

{
    if (m_processingQueue.isEmpty()) return; // processing was disabled
 
    processJob(m_processingQueue.takeFirst());
    if (!m_processingQueue.isEmpty())
        // Schedule to process the next torrent (if any)
        m_processingTimer->start();
}

References m_processingQueue, m_processingTimer, and processJob().

Referenced by AutoDownloader().

Here is the call graph for this function:

Here is the caller graph for this function:

processingStateChanged

void RSS::AutoDownloader::processingStateChanged ( bool  enabled )

signal

Referenced by AutomatedRssDownloader::AutomatedRssDownloader(), and setProcessingEnabled().

Here is the caller graph for this function:

processJob()

void AutoDownloader::processJob ( const QSharedPointer< ProcessingJob > &  job )

private

Definition at line 376 of file rss_autodownloader.cpp.

{
    for (AutoDownloadRule &rule : m_rules)
    {
        if (!rule.isEnabled()) continue;
        if (!rule.feedURLs().contains(job->feedURL)) continue;
        if (!rule.accepts(job->articleData)) continue;
 
        m_dirty = true;
        storeDeferred();
 
        BitTorrent::AddTorrentParams params;
        params.savePath = rule.savePath();
        params.category = rule.assignedCategory();
        params.addPaused = rule.addPaused();
        params.contentLayout = rule.torrentContentLayout();
        if (!rule.savePath().isEmpty())
            params.useAutoTMM = false;
        const auto torrentURL = job->articleData.value(Article::KeyTorrentURL).toString();
        BitTorrent::Session::instance()->addTorrent(torrentURL, params);
 
        if (BitTorrent::MagnetUri(torrentURL).isValid())
        {
            if (Feed *feed = Session::instance()->feedByURL(job->feedURL))
            {
                if (Article *article = feed->articleByGUID(job->articleData.value(Article::KeyId).toString()))
                    article->markAsRead();
            }
        }
        else
        {
            // waiting for torrent file downloading
            m_waitingJobs.insert(torrentURL, job);
        }
 
        return;
    }
}

References BitTorrent::AddTorrentParams::addPaused, BitTorrent::Session::addTorrent(), BitTorrent::AddTorrentParams::category, BitTorrent::AddTorrentParams::contentLayout, BitTorrent::Session::instance(), RSS::Session::instance(), RSS::Article::KeyId, RSS::Article::KeyTorrentURL, m_dirty, m_rules, m_waitingJobs, BitTorrent::AddTorrentParams::savePath, storeDeferred(), and BitTorrent::AddTorrentParams::useAutoTMM.

Referenced by process().

Here is the call graph for this function:

Here is the caller graph for this function:

removeRule()

void AutoDownloader::removeRule

(

const QString &

ruleName

)

Definition at line 210 of file rss_autodownloader.cpp.

{
    if (m_rules.contains(ruleName))
    {
        emit ruleAboutToBeRemoved(ruleName);
        m_rules.remove(ruleName);
        m_dirty = true;
        store();
    }
}

References m_dirty, m_rules, ruleAboutToBeRemoved(), and store().

Referenced by AutomatedRssDownloader::on_removeRuleBtn_clicked(), and RSSController::removeRuleAction().

Here is the call graph for this function:

Here is the caller graph for this function:

renameRule()

bool AutoDownloader::renameRule	(	const QString &	ruleName,
		const QString &	newRuleName
	)

Definition at line 196 of file rss_autodownloader.cpp.

{
    if (!hasRule(ruleName)) return false;
    if (hasRule(newRuleName)) return false;
 
    AutoDownloadRule rule = m_rules.take(ruleName);
    rule.setName(newRuleName);
    m_rules.insert(newRuleName, rule);
    m_dirty = true;
    store();
    emit ruleRenamed(newRuleName, ruleName);
    return true;
}

References hasRule(), m_dirty, m_rules, ruleRenamed(), RSS::AutoDownloadRule::setName(), and store().

Referenced by RSSController::renameRuleAction(), and AutomatedRssDownloader::renameSelectedRule().

Here is the call graph for this function:

Here is the caller graph for this function:

resetProcessingQueue()

void AutoDownloader::resetProcessingQueue ( )

private

Definition at line 480 of file rss_autodownloader.cpp.

{
    m_processingQueue.clear();
    if (!isProcessingEnabled()) return;
 
    for (Article *article : asConst(Session::instance()->rootFolder()->articles()))
    {
        if (!article->isRead() && !article->torrentUrl().isEmpty())
            addJobForArticle(article);
    }
}

References addJobForArticle(), asConst(), RSS::Session::instance(), isProcessingEnabled(), and m_processingQueue.

Referenced by insertRule(), and startProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

ruleAboutToBeRemoved

void RSS::AutoDownloader::ruleAboutToBeRemoved ( const QString &  ruleName )

signal

Referenced by AutomatedRssDownloader::AutomatedRssDownloader(), and removeRule().

Here is the caller graph for this function:

ruleAdded

void RSS::AutoDownloader::ruleAdded ( const QString &  ruleName )

signal

Referenced by AutomatedRssDownloader::AutomatedRssDownloader(), and insertRule().

Here is the caller graph for this function:

ruleByName()

AutoDownloadRule AutoDownloader::ruleByName

(

const QString &

ruleName

)

const

Definition at line 164 of file rss_autodownloader.cpp.

{
    return m_rules.value(ruleName, AutoDownloadRule("Unknown Rule"));
}

References m_rules.

Referenced by AutomatedRssDownloader::handleFeedCheckStateChange(), insertRule(), RSSController::matchingArticlesAction(), AutomatedRssDownloader::updateFeedList(), AutomatedRssDownloader::updateMatchingArticles(), and AutomatedRssDownloader::updateRuleDefinitionBox().

Here is the caller graph for this function:

ruleChanged

void RSS::AutoDownloader::ruleChanged ( const QString &  ruleName )

signal

Referenced by AutomatedRssDownloader::AutomatedRssDownloader(), and insertRule().

Here is the caller graph for this function:

ruleRenamed

void RSS::AutoDownloader::ruleRenamed ( const QString &  ruleName, const QString &  oldRuleName  )

signal

Referenced by AutomatedRssDownloader::AutomatedRssDownloader(), and renameRule().

Here is the caller graph for this function:

rules()

QList< AutoDownloadRule > AutoDownloader::rules

(

)

const

Definition at line 169 of file rss_autodownloader.cpp.

{
    return m_rules.values();
}

References m_rules.

Referenced by exportRulesToJSONFormat(), exportRulesToLegacyFormat(), loadRules(), loadRulesLegacy(), and RSSController::rulesAction().

Here is the caller graph for this function:

setDownloadRepacks()

void AutoDownloader::setDownloadRepacks

(

bool

enabled

)

Definition at line 321 of file rss_autodownloader.cpp.

{
    m_storeDownloadRepacks = enabled;
}

References m_storeDownloadRepacks.

Referenced by OptionsDialog::saveOptions(), and AppController::setPreferencesAction().

Here is the caller graph for this function:

setProcessingEnabled()

void AutoDownloader::setProcessingEnabled

(

bool

enabled

)

Definition at line 498 of file rss_autodownloader.cpp.

{
    if (m_storeProcessingEnabled != enabled)
    {
        m_storeProcessingEnabled = enabled;
        if (enabled)
        {
            startProcessing();
        }
        else
        {
            m_processingQueue.clear();
            disconnect(Session::instance()->rootFolder(), &Folder::newArticle, this, &AutoDownloader::handleNewArticle);
        }
 
        emit processingStateChanged(enabled);
    }
}

References handleNewArticle(), RSS::Session::instance(), m_processingQueue, m_storeProcessingEnabled, RSS::Item::newArticle(), processingStateChanged(), and startProcessing().

Referenced by OptionsDialog::saveOptions(), and AppController::setPreferencesAction().

Here is the call graph for this function:

Here is the caller graph for this function:

setRule_impl()

void AutoDownloader::setRule_impl ( const AutoDownloadRule &  rule )

private

Definition at line 358 of file rss_autodownloader.cpp.

{
    m_rules.insert(rule.name(), rule);
}

References m_rules, and RSS::AutoDownloadRule::name().

Referenced by insertRule(), and loadRules().

Here is the call graph for this function:

Here is the caller graph for this function:

setSmartEpisodeFilters()

void AutoDownloader::setSmartEpisodeFilters

(

const QStringList &

filters

)

Definition at line 308 of file rss_autodownloader.cpp.

{
    m_storeSmartEpisodeFilter = filters;
 
    const QString regex = computeSmartFilterRegex(filters);
    m_smartEpisodeRegex.setPattern(regex);
}

References computeSmartFilterRegex(), m_smartEpisodeRegex, and m_storeSmartEpisodeFilter.

Referenced by OptionsDialog::saveOptions(), and AppController::setPreferencesAction().

Here is the call graph for this function:

Here is the caller graph for this function:

smartEpisodeFilters()

QStringList AutoDownloader::smartEpisodeFilters

(

)

const

Definition at line 286 of file rss_autodownloader.cpp.

{
    const QVariant filter = m_storeSmartEpisodeFilter.get();
    if (filter.isNull())
    {
        const QStringList defaultFilters =
        {
            "s(\\d+)e(\\d+)",                       // Format 1: s01e01
            "(\\d+)x(\\d+)",                        // Format 2: 01x01
            "(\\d{4}[.\\-]\\d{1,2}[.\\-]\\d{1,2})", // Format 3: 2017.01.01
            "(\\d{1,2}[.\\-]\\d{1,2}[.\\-]\\d{4})"  // Format 4: 01.01.2017
        };
        return defaultFilters;
    }
    return filter.toStringList();
}

References SettingValue< T >::get(), and m_storeSmartEpisodeFilter.

Referenced by AutoDownloader(), OptionsDialog::loadOptions(), and AppController::preferencesAction().

Here is the call graph for this function:

Here is the caller graph for this function:

smartEpisodeRegex()

QRegularExpression AutoDownloader::smartEpisodeRegex

(

)

const

Definition at line 303 of file rss_autodownloader.cpp.

{
    return m_smartEpisodeRegex;
}

References m_smartEpisodeRegex.

Referenced by computeEpisodeName().

Here is the caller graph for this function:

startProcessing()

void AutoDownloader::startProcessing ( )

private

Definition at line 492 of file rss_autodownloader.cpp.

{
    resetProcessingQueue();
    connect(Session::instance()->rootFolder(), &Folder::newArticle, this, &AutoDownloader::handleNewArticle);
}

References handleNewArticle(), RSS::Session::instance(), RSS::Item::newArticle(), and resetProcessingQueue().

Referenced by AutoDownloader(), and setProcessingEnabled().

Here is the call graph for this function:

Here is the caller graph for this function:

store()

void AutoDownloader::store ( )

private

Definition at line 455 of file rss_autodownloader.cpp.

{
    if (!m_dirty) return;
 
    m_dirty = false;
    m_savingTimer.stop();
 
    QJsonObject jsonObj;
    for (const auto &rule : asConst(m_rules))
        jsonObj.insert(rule.name(), rule.toJsonObject());
 
    m_fileStorage->store(RulesFileName, QJsonDocument(jsonObj).toJson());
}

References asConst(), m_dirty, m_fileStorage, m_rules, m_savingTimer, RulesFileName(), and AsyncFileStorage::store().

Referenced by insertRule(), removeRule(), renameRule(), timerEvent(), and ~AutoDownloader().

Here is the call graph for this function:

Here is the caller graph for this function:

storeDeferred()

void AutoDownloader::storeDeferred ( )

private

Definition at line 469 of file rss_autodownloader.cpp.

{
    if (!m_savingTimer.isActive())
        m_savingTimer.start(5 * 1000, this);
}

References m_savingTimer.

Referenced by insertRule(), and processJob().

Here is the caller graph for this function:

timerEvent()

void AutoDownloader::timerEvent ( QTimerEvent *  event )

overrideprivate

Definition at line 517 of file rss_autodownloader.cpp.

{
    Q_UNUSED(event);
    store();
}

References store().

Here is the call graph for this function:

Friends And Related Function Documentation

::Application

friend class ::Application

friend

Definition at line 68 of file rss_autodownloader.h.

Member Data Documentation

m_dirty

bool RSS::AutoDownloader::m_dirty = false

private

Definition at line 145 of file rss_autodownloader.h.

Referenced by insertRule(), processJob(), removeRule(), renameRule(), and store().

m_fileStorage

AsyncFileStorage* RSS::AutoDownloader::m_fileStorage

private

Definition at line 141 of file rss_autodownloader.h.

Referenced by AutoDownloader(), load(), and store().

m_instance

QPointer< AutoDownloader > AutoDownloader::m_instance = nullptr

staticprivate

Definition at line 133 of file rss_autodownloader.h.

Referenced by AutoDownloader(), and instance().

m_ioThread

QThread* RSS::AutoDownloader::m_ioThread

private

Definition at line 140 of file rss_autodownloader.h.

Referenced by AutoDownloader(), and ~AutoDownloader().

m_processingQueue

QList<QSharedPointer<ProcessingJob> > RSS::AutoDownloader::m_processingQueue

private

Definition at line 143 of file rss_autodownloader.h.

Referenced by addJobForArticle(), process(), resetProcessingQueue(), and setProcessingEnabled().

m_processingTimer

QTimer* RSS::AutoDownloader::m_processingTimer

private

Definition at line 139 of file rss_autodownloader.h.

Referenced by addJobForArticle(), AutoDownloader(), and process().

m_rules

QHash<QString, AutoDownloadRule> RSS::AutoDownloader::m_rules

private

Definition at line 142 of file rss_autodownloader.h.

Referenced by hasRule(), processJob(), removeRule(), renameRule(), ruleByName(), rules(), setRule_impl(), and store().

m_savingTimer

QBasicTimer RSS::AutoDownloader::m_savingTimer

private

Definition at line 146 of file rss_autodownloader.h.

Referenced by store(), and storeDeferred().

m_smartEpisodeRegex

QRegularExpression RSS::AutoDownloader::m_smartEpisodeRegex

private

Definition at line 147 of file rss_autodownloader.h.

Referenced by AutoDownloader(), setSmartEpisodeFilters(), and smartEpisodeRegex().

m_storeDownloadRepacks

SettingValue<bool> RSS::AutoDownloader::m_storeDownloadRepacks

private

Definition at line 137 of file rss_autodownloader.h.

Referenced by downloadRepacks(), and setDownloadRepacks().

m_storeProcessingEnabled

CachedSettingValue<bool> RSS::AutoDownloader::m_storeProcessingEnabled

private

Definition at line 135 of file rss_autodownloader.h.

Referenced by isProcessingEnabled(), and setProcessingEnabled().

m_storeSmartEpisodeFilter

SettingValue<QVariant> RSS::AutoDownloader::m_storeSmartEpisodeFilter

private

Definition at line 136 of file rss_autodownloader.h.

Referenced by setSmartEpisodeFilters(), and smartEpisodeFilters().

m_waitingJobs

QHash<QString, QSharedPointer<ProcessingJob> > RSS::AutoDownloader::m_waitingJobs

private

Definition at line 144 of file rss_autodownloader.h.

Referenced by addJobForArticle(), handleTorrentDownloadFailed(), handleTorrentDownloadFinished(), and processJob().

---

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

• src/base/rss/rss_autodownloader.h
• src/base/rss/rss_autodownloader.cpp