DownloadHandlerImpl Class Reference

#include <downloadhandlerimpl.h>

Inheritance diagram for DownloadHandlerImpl:

Collaboration diagram for DownloadHandlerImpl:

Public Member Functions
	DownloadHandlerImpl (Net::DownloadManager *manager, const Net::DownloadRequest &downloadRequest)
void	cancel () override
QString	url () const
const Net::DownloadRequest	downloadRequest () const
void	assignNetworkReply (QNetworkReply *reply)

Private Member Functions
void	processFinishedDownload ()
void	checkDownloadSize (qint64 bytesReceived, qint64 bytesTotal)
void	handleRedirection (const QUrl &newUrl)
void	setError (const QString &error)
void	finish ()

Static Private Member Functions
static QString	errorCodeToString (QNetworkReply::NetworkError status)

Private Attributes
Net::DownloadManager *	m_manager = nullptr
QNetworkReply *	m_reply = nullptr
const Net::DownloadRequest	m_downloadRequest
short	m_redirectionCount = 0
Net::DownloadResult	m_result

Additional Inherited Members
Signals inherited from Net::DownloadHandler
void	finished (const DownloadResult &result)

Detailed Description

Definition at line 39 of file downloadhandlerimpl.h.

Constructor & Destructor Documentation

DownloadHandlerImpl()

DownloadHandlerImpl::DownloadHandlerImpl	(	Net::DownloadManager *	manager,
		const Net::DownloadRequest &	downloadRequest
	)

Definition at line 56 of file downloadhandlerimpl.cpp.

    : DownloadHandler {manager}
    , m_manager {manager}
    , m_downloadRequest {downloadRequest}
{
    m_result.url = url();
    m_result.status = Net::DownloadStatus::Success;
}

References m_result, Net::DownloadResult::status, Net::Success, url(), and Net::DownloadResult::url.

Here is the call graph for this function:

Member Function Documentation

assignNetworkReply()

void DownloadHandlerImpl::assignNetworkReply

(

QNetworkReply *

reply

)

Definition at line 78 of file downloadhandlerimpl.cpp.

{
    Q_ASSERT(reply);
    Q_ASSERT(!m_reply);
 
    m_reply = reply;
    m_reply->setParent(this);
    if (m_downloadRequest.limit() > 0)
        connect(m_reply, &QNetworkReply::downloadProgress, this, &DownloadHandlerImpl::checkDownloadSize);
    connect(m_reply, &QNetworkReply::finished, this, &DownloadHandlerImpl::processFinishedDownload);
}

References checkDownloadSize(), Net::DownloadRequest::limit(), m_downloadRequest, m_reply, and processFinishedDownload().

Here is the call graph for this function:

cancel()

void DownloadHandlerImpl::cancel ( )

overridevirtual

Implements Net::DownloadHandler.

Definition at line 65 of file downloadhandlerimpl.cpp.

{
    if (m_reply)
    {
        m_reply->abort();
    }
    else
    {
        setError(errorCodeToString(QNetworkReply::OperationCanceledError));
        finish();
    }
}

References errorCodeToString(), finish(), m_reply, and setError().

Here is the call graph for this function:

checkDownloadSize()

void DownloadHandlerImpl::checkDownloadSize ( qint64  bytesReceived, qint64  bytesTotal  )

private

Definition at line 152 of file downloadhandlerimpl.cpp.

{
    if ((bytesTotal > 0) && (bytesTotal <= m_downloadRequest.limit()))
    {
        // Total number of bytes is available
        disconnect(m_reply, &QNetworkReply::downloadProgress, this, &DownloadHandlerImpl::checkDownloadSize);
        return;
    }
 
    if ((bytesTotal > m_downloadRequest.limit()) || (bytesReceived > m_downloadRequest.limit()))
    {
        m_reply->abort();
        setError(tr("The file size (%1) exceeds the download limit (%2)")
                 .arg(Utils::Misc::friendlyUnit(bytesTotal)
                      , Utils::Misc::friendlyUnit(m_downloadRequest.limit())));
        finish();
    }
}

References finish(), Utils::Misc::friendlyUnit(), Net::DownloadRequest::limit(), m_downloadRequest, m_reply, and setError().

Referenced by assignNetworkReply().

Here is the call graph for this function:

Here is the caller graph for this function:

downloadRequest()

const Net::DownloadRequest DownloadHandlerImpl::downloadRequest

(

)

const

Definition at line 96 of file downloadhandlerimpl.cpp.

{
    return m_downloadRequest;
}

References m_downloadRequest.

errorCodeToString()

QString DownloadHandlerImpl::errorCodeToString ( QNetworkReply::NetworkError  status )

staticprivate

Definition at line 219 of file downloadhandlerimpl.cpp.

{
    switch (status)
    {
    case QNetworkReply::HostNotFoundError:
        return tr("The remote host name was not found (invalid hostname)");
    case QNetworkReply::OperationCanceledError:
        return tr("The operation was canceled");
    case QNetworkReply::RemoteHostClosedError:
        return tr("The remote server closed the connection prematurely, before the entire reply was received and processed");
    case QNetworkReply::TimeoutError:
        return tr("The connection to the remote server timed out");
    case QNetworkReply::SslHandshakeFailedError:
        return tr("SSL/TLS handshake failed");
    case QNetworkReply::ConnectionRefusedError:
        return tr("The remote server refused the connection");
    case QNetworkReply::ProxyConnectionRefusedError:
        return tr("The connection to the proxy server was refused");
    case QNetworkReply::ProxyConnectionClosedError:
        return tr("The proxy server closed the connection prematurely");
    case QNetworkReply::ProxyNotFoundError:
        return tr("The proxy host name was not found");
    case QNetworkReply::ProxyTimeoutError:
        return tr("The connection to the proxy timed out or the proxy did not reply in time to the request sent");
    case QNetworkReply::ProxyAuthenticationRequiredError:
        return tr("The proxy requires authentication in order to honor the request but did not accept any credentials offered");
    case QNetworkReply::ContentAccessDenied:
        return tr("The access to the remote content was denied (401)");
    case QNetworkReply::ContentOperationNotPermittedError:
        return tr("The operation requested on the remote content is not permitted");
    case QNetworkReply::ContentNotFoundError:
        return tr("The remote content was not found at the server (404)");
    case QNetworkReply::AuthenticationRequiredError:
        return tr("The remote server requires authentication to serve the content but the credentials provided were not accepted");
    case QNetworkReply::ProtocolUnknownError:
        return tr("The Network Access API cannot honor the request because the protocol is not known");
    case QNetworkReply::ProtocolInvalidOperationError:
        return tr("The requested operation is invalid for this protocol");
    case QNetworkReply::UnknownNetworkError:
        return tr("An unknown network-related error was detected");
    case QNetworkReply::UnknownProxyError:
        return tr("An unknown proxy-related error was detected");
    case QNetworkReply::UnknownContentError:
        return tr("An unknown error related to the remote content was detected");
    case QNetworkReply::ProtocolFailure:
        return tr("A breakdown in protocol was detected");
    default:
        return tr("Unknown error");
    }
}

Referenced by cancel(), and processFinishedDownload().

Here is the caller graph for this function:

finish()

void DownloadHandlerImpl::finish ( )

private

Definition at line 214 of file downloadhandlerimpl.cpp.

{
    emit finished(m_result);
}

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

Referenced by cancel(), checkDownloadSize(), handleRedirection(), and processFinishedDownload().

Here is the caller graph for this function:

handleRedirection()

void DownloadHandlerImpl::handleRedirection ( const QUrl &  newUrl )

private

Definition at line 171 of file downloadhandlerimpl.cpp.

{
    if (m_redirectionCount >= MAX_REDIRECTIONS)
    {
        setError(tr("Exceeded max redirections (%1)").arg(MAX_REDIRECTIONS));
        finish();
        return;
    }
 
    // Resolve relative urls
    const QUrl resolvedUrl = newUrl.isRelative() ? m_reply->url().resolved(newUrl) : newUrl;
    const QString newUrlString = resolvedUrl.toString();
    qDebug("Redirecting from %s to %s...", qUtf8Printable(m_reply->url().toString()), qUtf8Printable(newUrlString));
 
    // Redirect to magnet workaround
    if (newUrlString.startsWith("magnet:", Qt::CaseInsensitive))
    {
        qDebug("Magnet redirect detected.");
        m_result.status = Net::DownloadStatus::RedirectedToMagnet;
        m_result.magnet = newUrlString;
        m_result.errorString = tr("Redirected to magnet URI");
 
        finish();
        return;
    }
 
    auto redirected = static_cast<DownloadHandlerImpl *>(
                m_manager->download(Net::DownloadRequest(m_downloadRequest).url(newUrlString)));
    redirected->m_redirectionCount = m_redirectionCount + 1;
    connect(redirected, &DownloadHandlerImpl::finished, this, [this](const Net::DownloadResult &result)
    {
        m_result = result;
        m_result.url = url();
        finish();
    });
}

References Net::DownloadManager::download(), Net::DownloadResult::errorString, finish(), Net::DownloadHandler::finished(), m_downloadRequest, m_manager, m_redirectionCount, m_reply, m_result, Net::DownloadResult::magnet, MAX_REDIRECTIONS, Net::RedirectedToMagnet, setError(), Net::DownloadResult::status, url(), and Net::DownloadResult::url.

Referenced by processFinishedDownload().

Here is the call graph for this function:

Here is the caller graph for this function:

processFinishedDownload()

void DownloadHandlerImpl::processFinishedDownload ( )

private

Definition at line 101 of file downloadhandlerimpl.cpp.

{
    qDebug("Download finished: %s", qUtf8Printable(url()));
 
    // Check if the request was successful
    if (m_reply->error() != QNetworkReply::NoError)
    {
        // Failure
        qDebug("Download failure (%s), reason: %s", qUtf8Printable(url()), qUtf8Printable(errorCodeToString(m_reply->error())));
        setError(errorCodeToString(m_reply->error()));
        finish();
        return;
    }
 
    // Check if the server ask us to redirect somewhere else
    const QVariant redirection = m_reply->attribute(QNetworkRequest::RedirectionTargetAttribute);
    if (redirection.isValid())
    {
        handleRedirection(redirection.toUrl());
        return;
    }
 
    // Success
    m_result.data = (m_reply->rawHeader("Content-Encoding") == "gzip")
                    ? Utils::Gzip::decompress(m_reply->readAll())
                    : m_reply->readAll();
 
    if (m_downloadRequest.saveToFile())
    {
        const QString destinationPath = m_downloadRequest.destFileName();
        if (destinationPath.isEmpty())
        {
            const nonstd::expected<QString, QString> result = saveToTempFile(m_result.data);
            if (result)
                m_result.filePath = result.value();
            else
                setError(tr("I/O Error: %1").arg(result.error()));
        }
        else
        {
            const nonstd::expected<void, QString> result = Utils::IO::saveToFile(destinationPath, m_result.data);
            if (result)
                m_result.filePath = destinationPath;
            else
                setError(tr("I/O Error: %1").arg(result.error()));
        }
    }
 
    finish();
}

References Net::DownloadResult::data, Utils::Gzip::decompress(), Net::DownloadRequest::destFileName(), errorCodeToString(), Net::DownloadResult::filePath, finish(), handleRedirection(), m_downloadRequest, m_reply, m_result, Net::DownloadRequest::saveToFile(), Utils::IO::saveToFile(), anonymous_namespace{downloadhandlerimpl.cpp}::saveToTempFile(), setError(), and url().

Referenced by assignNetworkReply().

Here is the call graph for this function:

Here is the caller graph for this function:

setError()

void DownloadHandlerImpl::setError ( const QString &  error )

private

Definition at line 208 of file downloadhandlerimpl.cpp.

{
    m_result.errorString = error;
    m_result.status = Net::DownloadStatus::Failed;
}

References Net::DownloadResult::errorString, Net::Failed, m_result, and Net::DownloadResult::status.

Referenced by cancel(), checkDownloadSize(), handleRedirection(), and processFinishedDownload().

Here is the caller graph for this function:

url()

QString DownloadHandlerImpl::url

(

)

const

Definition at line 91 of file downloadhandlerimpl.cpp.

{
    return m_downloadRequest.url();
}

References m_downloadRequest, and Net::DownloadRequest::url().

Referenced by DownloadHandlerImpl(), handleRedirection(), and processFinishedDownload().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_downloadRequest

const Net::DownloadRequest DownloadHandlerImpl::m_downloadRequest

private

Definition at line 65 of file downloadhandlerimpl.h.

Referenced by assignNetworkReply(), checkDownloadSize(), downloadRequest(), handleRedirection(), processFinishedDownload(), and url().

m_manager

Net::DownloadManager* DownloadHandlerImpl::m_manager = nullptr

private

Definition at line 63 of file downloadhandlerimpl.h.

Referenced by handleRedirection().

m_redirectionCount

short DownloadHandlerImpl::m_redirectionCount = 0

private

Definition at line 66 of file downloadhandlerimpl.h.

Referenced by handleRedirection().

m_reply

QNetworkReply* DownloadHandlerImpl::m_reply = nullptr

private

Definition at line 64 of file downloadhandlerimpl.h.

Referenced by assignNetworkReply(), cancel(), checkDownloadSize(), handleRedirection(), and processFinishedDownload().

m_result

Net::DownloadResult DownloadHandlerImpl::m_result

private

Definition at line 67 of file downloadhandlerimpl.h.

Referenced by DownloadHandlerImpl(), finish(), handleRedirection(), processFinishedDownload(), and setError().

---

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

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