/************************************************************************** ** ** Copyright (C) 2025 The Qt Company Ltd. ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the Qt Installer Framework. ** ** $QT_BEGIN_LICENSE:GPL-EXCEPT$ ** Commercial License Usage ** Licensees holding valid commercial Qt licenses may use this file in ** accordance with the commercial license agreement provided with the ** Software or, alternatively, in accordance with the terms contained in ** a written agreement between you and The Qt Company. For licensing terms ** and conditions see https://www.qt.io/terms-conditions. For further ** information use the contact form at https://www.qt.io/contact-us. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 3 as published by the Free Software ** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT ** included in the packaging of this file. Please review the following ** information to ensure the GNU General Public License requirements will ** be met: https://www.gnu.org/licenses/gpl-3.0.html. ** ** $QT_END_LICENSE$ ** **************************************************************************/ #include "downloadarchivesjob.h" #include "binaryformatenginehandler.h" #include "component.h" #include "packagemanagercore.h" #include "fileutils.h" #include "abstractfiletask.h" #include "downloadfiletask.h" #include "filedownloader.h" #include "filedownloaderfactory.h" #include #include using namespace QInstaller; using namespace KDUpdater; /*! Creates a new DownloadArchivesJob with parent \a core. */ DownloadArchivesJob::DownloadArchivesJob(PackageManagerCore *core, const QString &objectName) : Job(core) , m_core(core) , m_archivesDownloaded(0) , m_canceled(false) , m_progressChangedTimerId(0) , m_currentDownloaded(0) , m_totalAmount(0) , m_retryDownload(false) { setCapabilities(Cancelable); setObjectName(objectName); } /*! Destroys the DownloadArchivesJob. */ DownloadArchivesJob::~DownloadArchivesJob() { for (auto i = m_downloaders.cbegin(), end = m_downloaders.cend(); i != end; ++i) { if (i.value()) i.value()->deleteLater(); } } /*! Sets the \a archives to download. The first value of each pair contains the file name to register the file in the installer's internal file system, the second one the source url. */ void DownloadArchivesJob::setArchivesToDownload(const QList> &archives) { m_archivesToDownload = archives; } /*! Sets the expected total size of archives to download to \a total. */ void DownloadArchivesJob::setExpectedTotalSize(quint64 total) { m_totalAmount = total; } /*! \reimp */ void DownloadArchivesJob::doStart() { m_totalDownloadSpeedTimer.start(); m_archivesDownloaded = 0; fetchArchives(); } /*! \reimp */ void DownloadArchivesJob::doCancel() { m_canceled = true; for (auto i = m_downloaders.cbegin(), end = m_downloaders.cend(); i != end; ++i) { if (i.value()) i.value()->reset(); } emitFinishedWithError(Job::Canceled, tr("Download canceled.")); } void DownloadArchivesJob::fetchArchives() { if (m_archivesToDownload.isEmpty()) { emitFinished(); return; } setupDownloaders(); for (auto i = m_downloaders.cbegin(), end = m_downloaders.cend(); i != end; ++i) { FileDownloader *downloader = i.value(); downloader->download(FileDownloader::DownloadType::ChecksumFile); } } void DownloadArchivesJob::networkDisconnected() { setTotalProcessedAmount(); } /*! This is used to reduce the \c progressChanged signals for \a event. */ void DownloadArchivesJob::timerEvent(QTimerEvent *event) { if (event->timerId() == m_progressChangedTimerId) { killTimer(m_progressChangedTimerId); m_progressChangedTimerId = 0; quint64 currentDownloaded = 0; for (auto i = m_downloaders.cbegin(), end = m_downloaders.cend(); i != end; ++i) currentDownloaded += i.value()->bytesReceived(); setProcessedAmount(currentDownloaded); // processedAmount might excess totalAmount if sha mismatch is detected // and some packages are refetched. if (totalAmount() != 0 && double(processedAmount()) > totalAmount()) { if (m_retryDownload) emit downloadStatusChanged(tr("Redownloading packages due to previous verification errors.")); return; } if (totalAmount() > 0) emit progressChanged(double(processedAmount()) / double(totalAmount())); onDownloadStatusChanged(currentDownloaded); } } /*! Builds a textual representation of the total download \a currentDownloaded and emits the \c {downloadStatusChanged()} signal. */ void DownloadArchivesJob::onDownloadStatusChanged(const quint64 currentDownloaded) { if (m_canceled) return; QString status; if (totalAmount() > 0) { QString bytesReceived = humanReadableSize(currentDownloaded); const QString bytesToReceive = humanReadableSize(totalAmount()); // remove the unit from the bytesReceived value if bytesToReceive has the same const QString tmp = bytesToReceive.mid(bytesToReceive.indexOf(QLatin1Char(' '))); if (bytesReceived.endsWith(tmp)) bytesReceived.chop(tmp.length()); status = tr("%1 of %2").arg(bytesReceived, bytesToReceive); } else if (currentDownloaded > 0) { status = tr("%1 downloaded.").arg(humanReadableSize(currentDownloaded)); } quint64 totalDownloadSpeed = 0; // Show download speed after download has fully started and we can more reliably // calculate the real download speed if (m_totalDownloadSpeedTimer.isValid() && m_totalDownloadSpeedTimer.elapsed() > 8000) totalDownloadSpeed = currentDownloaded / double(m_totalDownloadSpeedTimer.elapsed() / 1000); if (totalAmount() > 0 && totalDownloadSpeed > 0 && m_currentDownloaded != currentDownloaded) { const quint64 time = (totalAmount() - currentDownloaded) / totalDownloadSpeed; int s = time % 60; const int d = time / 86400; const int h = (time / 3600) - (d * 24); const int m = (time / 60) - (d * 1440) - (h * 60); QString days; if (d > 0) days = tr("%n day(s), ", "", d); QString hours; if (h > 0) hours = tr("%n hour(s), ", "", h); QString minutes; if (m > 0) minutes = tr("%n minute(s)", "", m); QString seconds; if (s >= 0 && minutes.isEmpty()) { s = (s <= 0 ? 1 : s); seconds = tr("%n second(s)", "", s); } status += tr(" - %1%2%3%4 remaining.").arg(days, hours, minutes, seconds); } else { status += tr(" - unknown time remaining."); } m_currentDownloaded = currentDownloaded; emit downloadStatusChanged(tr("Downloading: ")+ status); } void DownloadArchivesJob::setTotalProcessedAmount() { // Use timer to prevent UI from updating progress too frequently if (!m_progressChangedTimerId) m_progressChangedTimerId = startTimer(300); } /*! Registers the just downloaded file in the installer's file system. */ void DownloadArchivesJob::registerFile(const FileTaskItem &item) { if (m_canceled || m_archivesToDownload.isEmpty()) return; ++m_archivesDownloaded; if (m_progressChangedTimerId) { killTimer(m_progressChangedTimerId); m_progressChangedTimerId = 0; } BinaryFormatEngineHandler::instance()->registerResource(item.value(TaskRole::Name).toString(), item.target()); emit fileDownloadReady(item.target()); } void DownloadArchivesJob::fileDownloaded(const QString &fileName, const QString &componentName) { emit outputTextChanged(tr("Archive \"%1\" downloaded for component %2.") .arg(fileName, componentName)); } void DownloadArchivesJob::retryFileDownload(const QString &fileName) { m_retryDownload = true; emit outputTextChanged(tr("Hash verification error while downloading %1. " "This can be a temporary error, retrying download.").arg(fileName)); } void DownloadArchivesJob::downloadCompleted() { // Wait for all downloaders to complete for (auto i = m_downloaders.cbegin(), end = m_downloaders.cend(); i != end; ++i) { if (!i.value()->dataDownloded()) return; } emitFinished(); m_archivesToDownload.clear(); } void DownloadArchivesJob::sha1DownloadFinished() { // Wait for all downloaders to complete for (auto i = m_downloaders.cbegin(), end = m_downloaders.cend(); i != end; ++i) { if (!i.value()->sha1Downloded()) return; } // Start showing progress of downloaded data setTotalAmount(m_totalAmount); } void DownloadArchivesJob::downloadAborted(const JobError error, const QString &errorStr) { if (m_canceled) return; emitFinishedWithError(error, errorStr); } void DownloadArchivesJob::finishWithError(const QString &error) { emitFinishedWithError(QInstaller::DownloadError, error); } void DownloadArchivesJob::setupDownloaders() { KDUpdater::FileDownloader *downloader = nullptr; const QString &queryString = m_core->value(scUrlQueryString); for (QPair item : std::as_const(m_archivesToDownload)) { const QFileInfo fi = QFileInfo(item.first); const Component *const component = m_core->componentByName(PackageManagerCore::checkableName(QFileInfo(fi.path()).fileName())); if (!component) { emit outputTextChanged(tr("Cannot find component for %1.").arg(QFileInfo(fi.path()).fileName())); continue; } QString fullQueryString; if (!queryString.isEmpty()) fullQueryString = QLatin1String("?") + queryString; const QUrl url(item.second + QLatin1String(".sha1") + fullQueryString); const QString &scheme = url.scheme(); if (m_downloaders.contains(scheme)) { downloader = m_downloaders.value(scheme); } else { downloader = FileDownloaderFactory::instance().create(scheme, this); if (!downloader) { emit outputTextChanged(tr("Scheme %1 not supported (URL: %2).").arg(scheme, url.toString())); return; } downloader->setPackageManagerCore(m_core); m_downloaders.insert(scheme, downloader); } QString fname = item.first; QString target = (component->localTempPath() + QLatin1Char('/') + component->name() + QLatin1Char('/') + fi.fileName() + QLatin1String(".sha1")); QString source = url.toString(); if (scheme == QLatin1String("file")) source = url.toLocalFile(); FileTaskItem taskItem(source, target); taskItem.insert(TaskRole::Name, fname); taskItem.insert(TaskRole::ComponentName, component->displayName()); QAuthenticator authenticator; authenticator.setUser(component->value(QLatin1String("username"))); authenticator.setPassword(component->value(QLatin1String("password"))); taskItem.insert(TaskRole::Authenticator, QVariant::fromValue(authenticator)); downloader->addFileItem(taskItem); } for (auto i = m_downloaders.cbegin(), end = m_downloaders.cend(); i != end; ++i) { connect(i.value(), &FileDownloader::downloadAborted, this, &DownloadArchivesJob::downloadAborted, Qt::QueuedConnection); connect(i.value(), &FileDownloader::setProcessedAmount, this, &DownloadArchivesJob::setTotalProcessedAmount, Qt::QueuedConnection); connect(i.value(), &FileDownloader::sha1DownloadFinished, this, &DownloadArchivesJob::sha1DownloadFinished, Qt::QueuedConnection); connect(i.value(), &FileDownloader::registerFile, this, &DownloadArchivesJob::registerFile, Qt::QueuedConnection); connect(i.value(), &FileDownloader::fileDownloaded, this, &DownloadArchivesJob::fileDownloaded, Qt::QueuedConnection); connect(i.value(), &FileDownloader::retryFileDownload, this, &DownloadArchivesJob::retryFileDownload, Qt::QueuedConnection); connect(i.value(), &FileDownloader::downloadCompleted, this, &DownloadArchivesJob::downloadCompleted, Qt::QueuedConnection); connect(i.value(), &FileDownloader::networkDisconnected, this, &DownloadArchivesJob::networkDisconnected, Qt::QueuedConnection); } }