kde-extraapps/kget/transfer-plugins/kio/transferKio.cpp

/* This file is part of the KDE project

   Copyright (C) 2004 Dario Massarin <nekkar@libero.it>
   Copyright (C) 2009 Matthias Fuchs <mat69@gmx.net>

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
*/

#include "transferKio.h"
#include "core/kget.h"
#include "core/transferdatasource.h"
#include "settings.h"

#include <kio/scheduler.h>
#include <KIO/DeleteJob>
#include <KIO/CopyJob>
#include <KIO/NetAccess>
#include <KLocale>
#include <KProtocolManager>
#include <KMessageBox>
#include <KDebug>

TransferKio::TransferKio(TransferGroup * parent, TransferFactory * factory,
                         Scheduler * scheduler, const KUrl & source, const KUrl & dest)
    : Transfer(parent, factory, scheduler, source, dest),
      m_copyjob(nullptr),
      m_verifier(nullptr),
      m_filemodel(nullptr)
{
    if (KProtocolManager::autoResume()) {
        setCapabilities(Transfer::Cap_Resuming);
    }
}

void TransferKio::start()
{
    if (status() != Job::Finished) {
        kDebug() << "TransferKio::start";
        setStatus(Job::Running);
        setTransferChange(Transfer::Tc_Status, true);

        if (Settings::checksumAutomaticVerification()) {
            QDomDocument doc;
            QDomElement element = doc.createElement("TransferDataSource");
            element.setAttribute("type", "checksumsearch");
            doc.appendChild(element);

            TransferDataSource *checksumSearch = KGet::createTransferDataSource(m_source, element, this);
            if (checksumSearch) {
                connect(checksumSearch, SIGNAL(data(QString,QString)), this, SLOT(slotChecksumFound(QString,QString)));
                checksumSearch->start();
            }
        }

        createJob();
    }
}

void TransferKio::stop()
{
    if (status() == Job::Stopped || status() == Job::Finished) {
        return;
    }

    if (m_copyjob) {
        m_copyjob->kill(KJob::EmitResult);
        m_copyjob = nullptr;
    }

    kDebug() << "Stop";
    setStatus(Job::Stopped);
    m_downloadSpeed = 0;
    setTransferChange(Transfer::Tc_Status | Transfer::Tc_DownloadSpeed, true);
}

void TransferKio::deinit(Transfer::DeleteOptions options)
{
    if (options & Transfer::DeleteFiles) {
        KIO::Job *del = KIO::del(m_dest, KIO::HideProgressInfo);
        KIO::NetAccess::synchronousRun(del, 0);
    }

    if (options & Transfer::DeleteTemporaryFiles) {
        KIO::Job *del = KIO::del(m_dest.path() + ".part", KIO::HideProgressInfo);
        KIO::NetAccess::synchronousRun(del, 0);
    }
}

bool TransferKio::repair(const KUrl &file)
{
    Q_UNUSED(file);

    if (verifier()->status() == Verifier::NotVerified) {
        m_downloadedSize = 0;
        m_percent = 0;
        if (m_copyjob) {
            m_copyjob->kill(KJob::Quietly);
            m_copyjob = nullptr;
        }
        setTransferChange(Transfer::Tc_DownloadedSize | Transfer::Tc_Percent, true);

        start();

        return true;
    }

    return false;
}

Verifier *TransferKio::verifier(const KUrl &file)
{
    Q_UNUSED(file);

    if (!m_verifier) {
        m_verifier = new Verifier(m_dest, this);
        connect(m_verifier, SIGNAL(verified(bool)), this, SLOT(slotVerified(bool)));
    }

    foreach (const QString &checksumtype, m_checksums.keys()) {
        const QString checksumvalue = m_checksums.value(checksumtype);
        m_verifier->addChecksum(checksumtype, checksumvalue);
    }

    return m_verifier;
}

FileModel *TransferKio::fileModel()
{
    if (!m_filemodel) {
        m_filemodel = new FileModel(files(), directory(), this);
    }

    const KUrl fileurl = m_dest;

    QModelIndex fileindex = m_filemodel->index(fileurl, FileItem::File);
    m_filemodel->setData(fileindex, Qt::Checked, Qt::CheckStateRole);

    QModelIndex statusindex = m_filemodel->index(fileurl, FileItem::Status);
    m_filemodel->setData(statusindex, status());

    QModelIndex sizeindex = m_filemodel->index(fileurl, FileItem::Size);
    m_filemodel->setData(sizeindex, m_totalSize);

    QModelIndex checksumindex = m_filemodel->index(fileurl, FileItem::ChecksumVerified);
    m_filemodel->setData(checksumindex, verifier()->status());

    return m_filemodel;
}

void TransferKio::save(const QDomElement &element)
{
    QDomElement elementcopy = element;
    QString checksumsstring;
    bool firstappend = true;
    foreach (const QString &checksumtype, m_checksums.keys()) {
        const QString checksumvalue = m_checksums.value(checksumtype);
        if (firstappend) {
            checksumsstring.append(QString::fromLatin1("%1,%2").arg(checksumtype).arg(checksumvalue));
            firstappend = false;
        } else {
            checksumsstring.append(QString::fromLatin1(";%1,%2").arg(checksumtype).arg(checksumvalue));
        }
    }
    elementcopy.setAttribute("Checksums", checksumsstring);

    Transfer::save(elementcopy);
}

void TransferKio::load(const QDomElement *element)
{
    Transfer::load(element);

    m_checksums.clear();
    if (element) {
        const QStringList checksums = element->attribute("Checksums").split(";");
        foreach (const QString &checksum, checksums) {
            const QStringList splitchecksum = checksum.split(",");
            if (splitchecksum.size() != 2) {
                kDebug() << "invalid checksum" << checksum;
                continue;
            }
            m_checksums.insert(splitchecksum.at(0), splitchecksum.at(1));
        }
    }
}

// NOTE: INTERNAL METHODS
void TransferKio::createJob()
{
    if (!m_copyjob) {
        m_copyjob = KIO::file_copy(m_source, m_dest, -1, KIO::HideProgressInfo);

        connect(m_copyjob, SIGNAL(result(KJob*)), 
                this, SLOT(slotResult(KJob*)));
        connect(m_copyjob, SIGNAL(infoMessage(KJob*,QString)), 
                this, SLOT(slotInfoMessage(KJob*,QString)));
        connect(m_copyjob, SIGNAL(percent(KJob*,ulong)), 
                this, SLOT(slotPercent(KJob*,ulong)));
        connect(m_copyjob, SIGNAL(totalSize(KJob*,qulonglong)), 
                this, SLOT(slotTotalSize(KJob*,qulonglong)));
        connect(m_copyjob, SIGNAL(processedSize(KJob*,qulonglong)), 
                this, SLOT(slotProcessedSize(KJob*,qulonglong)));
        connect(m_copyjob, SIGNAL(speed(KJob*,ulong)), 
                this, SLOT(slotSpeed(KJob*,ulong)));
    }
}

void TransferKio::slotResult( KJob * kioJob )
{
    kDebug() << "slotResult" << kioJob->error() << kioJob->errorString();

    m_downloadSpeed = 0;
    setTransferChange(Transfer::Tc_DownloadSpeed, true);

    switch (kioJob->error()) {
        case 0:                            // The download has finished
        case KIO::ERR_FILE_ALREADY_EXIST: { // The file has already been downloaded.
            setStatus(Job::Finished);
            m_percent = 100;
            m_downloadedSize = m_totalSize = QFile(m_dest.path()).size();
            setTransferChange(Transfer::Tc_Status | Transfer::Tc_Percent | Transfer::Tc_DownloadedSize | Transfer::Tc_TotalSize, true);
            break;
        }
        default: {
            // There has been an error
            setError(kioJob->errorString(), SmallIcon("dialog-error"), Job::ManualSolve);
            setStatus(Job::Aborted);
            setLog(kioJob->errorString(), Transfer::Log_Error);
            setTransferChange(Transfer::Tc_Status | Transfer::Tc_Log, true);
            break;
        }
    }
    // when slotResult gets called, the m_copyjob has already been deleted!
    m_copyjob = nullptr;

    if (status() == Job::Finished) {
        if (m_verifier && Settings::checksumAutomaticVerification()) {
            m_verifier->verify();
        }
    }
}

void TransferKio::slotInfoMessage( KJob * kioJob, const QString & msg )
{
    kDebug() << "slotInfoMessage";
    Q_UNUSED(kioJob);

    setLog(msg, Transfer::Log_Info);
    setTransferChange(Transfer::Tc_Log, true);
}

void TransferKio::slotPercent( KJob * kioJob, unsigned long percent )
{
    kDebug() << "slotPercent";
    Q_UNUSED(kioJob);

    m_percent = percent;
    setTransferChange(Transfer::Tc_Percent, true);
}

void TransferKio::slotTotalSize( KJob * kioJob, qulonglong size )
{
    kDebug() << "slotTotalSize";
    Q_UNUSED(kioJob);

    m_totalSize = size;
    setTransferChange(Transfer::Tc_TotalSize, true);
}

void TransferKio::slotProcessedSize( KJob * kioJob, qulonglong size )
{
    kDebug() << "slotProcessedSize";
    Q_UNUSED(kioJob);

    m_downloadedSize = size;
    setTransferChange(Transfer::Tc_DownloadedSize, true);
}

void TransferKio::slotSpeed( KJob * kioJob, unsigned long bytes_per_second )
{
    kDebug() << "slotSpeed";
    Q_UNUSED(kioJob)

    m_downloadSpeed = bytes_per_second;
    setTransferChange(Transfer::Tc_DownloadSpeed, true);
}

void TransferKio::slotVerified(bool isVerified)
{
    if (!isVerified) {
        QString text = i18n("The download (%1) could not be verified. Do you want to repair it?", m_dest.fileName());

        if (!verifier()->partialChunkLength()) {
            text = i18n("The download (%1) could not be verified. Do you want to redownload it?", m_dest.fileName());
        }
        if (KMessageBox::warningYesNo(0,
                                      text,
                                      i18n("Verification failed.")) == KMessageBox::Yes) {
            repair();
        }
    }
}

void TransferKio::slotChecksumFound(QString type, QString checksum)
{
    verifier()->addChecksum(type, checksum);
    m_checksums.insert(type, checksum);
}

#include "moc_transferKio.cpp"