Net::DownloadManager Class Reference

#include <downloadmanager.h>

Inheritance diagram for Net::DownloadManager:

Collaboration diagram for Net::DownloadManager:

Public Member Functions
DownloadHandler *	download (const DownloadRequest &downloadRequest)
template<typename Context , typename Func >
void	download (const DownloadRequest &downloadRequest, Context context, Func &&slot)
void	registerSequentialService (const ServiceID &serviceID)
QList< QNetworkCookie >	cookiesForUrl (const QUrl &url) const
bool	setCookiesFromUrl (const QList< QNetworkCookie > &cookieList, const QUrl &url)
QList< QNetworkCookie >	allCookies () const
void	setAllCookies (const QList< QNetworkCookie > &cookieList)
bool	deleteCookie (const QNetworkCookie &cookie)

Static Public Member Functions
static void	initInstance ()
static void	freeInstance ()
static DownloadManager *	instance ()
static bool	hasSupportedScheme (const QString &url)

Private Slots
void	ignoreSslErrors (QNetworkReply *, const QList< QSslError > &)

Private Member Functions
	DownloadManager (QObject *parent=nullptr)
void	applyProxySettings ()
void	handleReplyFinished (const QNetworkReply *reply)

Private Attributes
QNetworkAccessManager	m_networkManager
QSet< ServiceID >	m_sequentialServices
QSet< ServiceID >	m_busyServices
QHash< ServiceID, QQueue< DownloadHandler * > >	m_waitingJobs

Static Private Attributes
static DownloadManager *	m_instance = nullptr

Detailed Description

Definition at line 119 of file downloadmanager.h.

Constructor & Destructor Documentation

DownloadManager()

Net::DownloadManager::DownloadManager ( QObject *  parent = nullptr )

explicitprivate

Definition at line 137 of file downloadmanager.cpp.

    : QObject(parent)
{
    connect(&m_networkManager, &QNetworkAccessManager::sslErrors, this, &Net::DownloadManager::ignoreSslErrors);
    connect(&m_networkManager, &QNetworkAccessManager::finished, this, &DownloadManager::handleReplyFinished);
    connect(ProxyConfigurationManager::instance(), &ProxyConfigurationManager::proxyConfigurationChanged
            , this, &DownloadManager::applyProxySettings);
    m_networkManager.setCookieJar(new NetworkCookieJar(this));
    applyProxySettings();
}

References applyProxySettings(), handleReplyFinished(), ignoreSslErrors(), Net::ProxyConfigurationManager::instance(), m_networkManager, and Net::ProxyConfigurationManager::proxyConfigurationChanged().

Here is the call graph for this function:

Member Function Documentation

allCookies()

QList< QNetworkCookie > Net::DownloadManager::allCookies

(

)

const

Definition at line 209 of file downloadmanager.cpp.

{
    return static_cast<NetworkCookieJar *>(m_networkManager.cookieJar())->allCookies();
}

applyProxySettings()

void Net::DownloadManager::applyProxySettings ( )

private

Definition at line 233 of file downloadmanager.cpp.

{
    const auto *proxyManager = ProxyConfigurationManager::instance();
    const ProxyConfiguration proxyConfig = proxyManager->proxyConfiguration();
    QNetworkProxy proxy;
 
    if (!proxyManager->isProxyOnlyForTorrents() && (proxyConfig.type != ProxyType::None))
    {
        // Proxy enabled
        proxy.setHostName(proxyConfig.ip);
        proxy.setPort(proxyConfig.port);
        // Default proxy type is HTTP, we must change if it is SOCKS5
        if ((proxyConfig.type == ProxyType::SOCKS5) || (proxyConfig.type == ProxyType::SOCKS5_PW))
        {
            qDebug() << Q_FUNC_INFO << "using SOCKS proxy";
            proxy.setType(QNetworkProxy::Socks5Proxy);
        }
        else
        {
            qDebug() << Q_FUNC_INFO << "using HTTP proxy";
            proxy.setType(QNetworkProxy::HttpProxy);
        }
        // Authentication?
        if (proxyManager->isAuthenticationRequired())
        {
            qDebug("Proxy requires authentication, authenticating...");
            proxy.setUser(proxyConfig.username);
            proxy.setPassword(proxyConfig.password);
        }
    }
    else
    {
        proxy.setType(QNetworkProxy::NoProxy);
    }
 
    m_networkManager.setProxy(proxy);
}

References Net::ProxyConfigurationManager::instance(), Net::ProxyConfiguration::ip, Net::None, Net::ProxyConfiguration::password, Net::ProxyConfiguration::port, Net::SOCKS5, Net::SOCKS5_PW, Net::ProxyConfiguration::type, and Net::ProxyConfiguration::username.

Referenced by DownloadManager().

Here is the call graph for this function:

Here is the caller graph for this function:

cookiesForUrl()

QList< QNetworkCookie > Net::DownloadManager::cookiesForUrl

(

const QUrl &

url

)

const

Definition at line 199 of file downloadmanager.cpp.

{
    return m_networkManager.cookieJar()->cookiesForUrl(url);
}

deleteCookie()

bool Net::DownloadManager::deleteCookie

(

const QNetworkCookie &

cookie

)

Definition at line 219 of file downloadmanager.cpp.

{
    return static_cast<NetworkCookieJar *>(m_networkManager.cookieJar())->deleteCookie(cookie);
}

download() [1/2]

Net::DownloadHandler * Net::DownloadManager::download

(

const DownloadRequest &

downloadRequest

)

Definition at line 165 of file downloadmanager.cpp.

{
    // Process download request
    const QNetworkRequest request = createNetworkRequest(downloadRequest);
    const ServiceID id = ServiceID::fromURL(request.url());
    const bool isSequentialService = m_sequentialServices.contains(id);
 
    auto downloadHandler = new DownloadHandlerImpl {this, downloadRequest};
    connect(downloadHandler, &DownloadHandler::finished, downloadHandler, &QObject::deleteLater);
    connect(downloadHandler, &QObject::destroyed, this, [this, id, downloadHandler]()
    {
        m_waitingJobs[id].removeOne(downloadHandler);
    });
 
    if (isSequentialService && m_busyServices.contains(id))
    {
        m_waitingJobs[id].enqueue(downloadHandler);
    }
    else
    {
        qDebug("Downloading %s...", qUtf8Printable(downloadRequest.url()));
        if (isSequentialService)
            m_busyServices.insert(id);
        downloadHandler->assignNetworkReply(m_networkManager.get(request));
    }
 
    return downloadHandler;
}

References anonymous_namespace{downloadmanager.cpp}::createNetworkRequest(), Net::DownloadHandler::finished(), Net::ServiceID::fromURL(), and Net::DownloadRequest::url().

Referenced by BitTorrent::Session::addTorrent(), ProgramUpdater::checkForUpdates(), Net::DNSUpdater::checkPublicIP(), download(), Net::GeoIPManager::downloadDatabaseFile(), TrackerFiltersList::downloadFavicon(), RSS::Feed::downloadIcon(), DownloadHandlerImpl::handleRedirection(), TrackersAdditionDialog::on_uTorrentListButton_clicked(), RSS::Feed::refresh(), AddNewTorrentDialog::show(), and Net::DNSUpdater::updateDNSService().

Here is the call graph for this function:

Here is the caller graph for this function:

download() [2/2]

template<typename Context , typename Func >

void Net::DownloadManager::download	(	const DownloadRequest &	downloadRequest,
		Context	context,
		Func &&	slot
	)

Definition at line 162 of file downloadmanager.h.

    {
        const DownloadHandler *handler = download(downloadRequest);
        connect(handler, &DownloadHandler::finished, context, slot);
    }

References download(), and Net::DownloadHandler::finished().

Here is the call graph for this function:

freeInstance()

void Net::DownloadManager::freeInstance ( )

static

Definition at line 154 of file downloadmanager.cpp.

{
    delete m_instance;
    m_instance = nullptr;
}

Referenced by Application::cleanup().

Here is the caller graph for this function:

handleReplyFinished()

void Net::DownloadManager::handleReplyFinished ( const QNetworkReply *  reply )

private

Definition at line 271 of file downloadmanager.cpp.

{
    // QNetworkReply::url() may be different from that of the original request
    // so we need QNetworkRequest::url() to properly process Sequential Services
    // in the case when the redirection occurred.
    const ServiceID id = ServiceID::fromURL(reply->request().url());
    const auto waitingJobsIter = m_waitingJobs.find(id);
    if ((waitingJobsIter == m_waitingJobs.end()) || waitingJobsIter.value().isEmpty())
    {
        // No more waiting jobs for given ServiceID
        m_busyServices.remove(id);
        return;
    }
 
    auto handler = static_cast<DownloadHandlerImpl *>(waitingJobsIter.value().dequeue());
    qDebug("Downloading %s...", qUtf8Printable(handler->url()));
    handler->assignNetworkReply(m_networkManager.get(createNetworkRequest(handler->downloadRequest())));
    handler->disconnect(this);
}

References anonymous_namespace{downloadmanager.cpp}::createNetworkRequest(), and Net::ServiceID::fromURL().

Referenced by DownloadManager().

Here is the call graph for this function:

Here is the caller graph for this function:

hasSupportedScheme()

bool Net::DownloadManager::hasSupportedScheme ( const QString &  url )

static

Definition at line 224 of file downloadmanager.cpp.

{
    const QStringList schemes = instance()->m_networkManager.supportedSchemes();
    return std::any_of(schemes.cbegin(), schemes.cend(), [&url](const QString &scheme)
    {
        return url.startsWith((scheme + QLatin1Char(':')), Qt::CaseInsensitive);
    });
}

Referenced by BitTorrent::Session::addTorrent(), PluginSelectDialog::askForPluginUrl(), SearchPluginManager::installPlugin(), anonymous_namespace{mainwindow.cpp}::isTorrentLink(), RSSWidget::on_newFeedButton_clicked(), and AddNewTorrentDialog::show().

Here is the caller graph for this function:

ignoreSslErrors

void Net::DownloadManager::ignoreSslErrors ( QNetworkReply *  reply, const QList< QSslError > &  errors  )

privateslot

Definition at line 291 of file downloadmanager.cpp.

{
    QStringList errorList;
    for (const QSslError &error : errors)
        errorList += error.errorString();
    LogMsg(tr("Ignoring SSL error, URL: \"%1\", errors: \"%2\"").arg(reply->url().toString(), errorList.join(". ")), Log::WARNING);
 
    // Ignore all SSL errors
    reply->ignoreSslErrors();
}

References LogMsg(), and Log::WARNING.

Referenced by DownloadManager().

Here is the call graph for this function:

Here is the caller graph for this function:

initInstance()

void Net::DownloadManager::initInstance ( )

static

Definition at line 148 of file downloadmanager.cpp.

{
    if (!m_instance)
        m_instance = new DownloadManager;
}

Referenced by Application::exec().

Here is the caller graph for this function:

instance()

Net::DownloadManager * Net::DownloadManager::instance ( )

static

Definition at line 160 of file downloadmanager.cpp.

{
    return m_instance;
}

Referenced by CookiesDialog::accept(), TorrentsController::addAction(), BitTorrent::Session::addTorrent(), ProgramUpdater::checkForUpdates(), Net::DNSUpdater::checkPublicIP(), Net::GeoIPManager::downloadDatabaseFile(), TrackerFiltersList::downloadFavicon(), RSS::Feed::downloadIcon(), RSS::Feed::Feed(), TrackersAdditionDialog::on_uTorrentListButton_clicked(), RSS::Feed::refresh(), AddNewTorrentDialog::show(), and Net::DNSUpdater::updateDNSService().

Here is the caller graph for this function:

registerSequentialService()

void Net::DownloadManager::registerSequentialService

(

const ServiceID &

serviceID

)

Definition at line 194 of file downloadmanager.cpp.

{
    m_sequentialServices.insert(serviceID);
}

Referenced by RSS::Feed::Feed().

Here is the caller graph for this function:

setAllCookies()

void Net::DownloadManager::setAllCookies

(

const QList< QNetworkCookie > &

cookieList

)

Definition at line 214 of file downloadmanager.cpp.

{
    static_cast<NetworkCookieJar *>(m_networkManager.cookieJar())->setAllCookies(cookieList);
}

Referenced by CookiesDialog::accept().

Here is the caller graph for this function:

setCookiesFromUrl()

bool Net::DownloadManager::setCookiesFromUrl	(	const QList< QNetworkCookie > &	cookieList,
		const QUrl &	url
	)

Definition at line 204 of file downloadmanager.cpp.

{
    return m_networkManager.cookieJar()->setCookiesFromUrl(cookieList, url);
}

Referenced by TorrentsController::addAction().

Here is the caller graph for this function:

Member Data Documentation

m_busyServices

QSet<ServiceID> Net::DownloadManager::m_busyServices

private

Definition at line 157 of file downloadmanager.h.

m_instance

Net::DownloadManager * Net::DownloadManager::m_instance = nullptr

staticprivate

Definition at line 153 of file downloadmanager.h.

m_networkManager

QNetworkAccessManager Net::DownloadManager::m_networkManager

private

Definition at line 154 of file downloadmanager.h.

Referenced by DownloadManager().

m_sequentialServices

QSet<ServiceID> Net::DownloadManager::m_sequentialServices

private

Definition at line 156 of file downloadmanager.h.

m_waitingJobs

QHash<ServiceID, QQueue<DownloadHandler *> > Net::DownloadManager::m_waitingJobs

private

Definition at line 158 of file downloadmanager.h.

---

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

• src/base/net/downloadmanager.h
• src/base/net/downloadmanager.cpp