jobs.cpp 24.9 KB
Newer Older
1 2
/*
 * Copyright (c) 2007 Henrique Pinto <henrique.pinto@kdemail.net>
3
 * Copyright (c) 2008-2009 Harald Hvaal <haraldhv@stud.ntnu.no>
4
 * Copyright (c) 2009-2012 Raphael Kubo da Costa <rakuco@FreeBSD.org>
5
 * Copyright (c) 2016 Vladyslav Batyrenko <mvlabat@gmail.com>
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES ( INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION ) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * ( INCLUDING NEGLIGENCE OR OTHERWISE ) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
28

29
#include "jobs.h"
30
#include "archiveentry.h"
31
#include "ark_debug.h"
32

33
#include <QDir>
34
#include <QDirIterator>
35
#include <QFileInfo>
36
#include <QRegularExpression>
37
#include <QThread>
38
#include <QTimer>
Elvis Angelaccio's avatar
Elvis Angelaccio committed
39
#include <QUrl>
40

Elvis Angelaccio's avatar
Elvis Angelaccio committed
41
#include <KIO/RenameDialog>
42
#include <KLocalizedString>
43

44 45
namespace Kerfuffle
{
46

47 48
class Job::Private : public QThread
{
Elvis Angelaccio's avatar
Elvis Angelaccio committed
49 50
    Q_OBJECT

51
public:
Elvis Angelaccio's avatar
Elvis Angelaccio committed
52
    Private(Job *job, QObject *parent = nullptr)
53 54 55 56 57
        : QThread(parent)
        , q(job)
    {
    }

58
    void run() override;
59

60
private:
61 62 63 64 65
    Job *q;
};

void Job::Private::run()
{
66
    q->doWork();
67 68
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
69
Job::Job(Archive *archive, ReadOnlyArchiveInterface *interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
70
    : KJob()
Elvis Angelaccio's avatar
Elvis Angelaccio committed
71
    , m_archive(archive)
72
    , m_archiveInterface(interface)
73
    , d(new Private(this))
74 75 76 77
{
    setCapabilities(KJob::Killable);
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
78
Job::Job(Archive *archive)
79
    : Job(archive, nullptr)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
80 81 82
{}

Job::Job(ReadOnlyArchiveInterface *interface)
83
    : Job(nullptr, interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
84 85
{}

86 87
Job::~Job()
{
88 89
    if (d->isRunning()) {
        d->wait();
90 91
    }

92
    delete d;
93
}
94

95 96
ReadOnlyArchiveInterface *Job::archiveInterface()
{
Elvis Angelaccio's avatar
Elvis Angelaccio committed
97 98 99 100 101 102
    // Use the archive interface.
    if (archive()) {
        return archive()->interface();
    }

    // Use the interface passed to this job (e.g. JSONArchiveInterface in jobstest.cpp).
103 104 105
    return m_archiveInterface;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
Archive *Job::archive() const
{
    return m_archive;
}

QString Job::errorString() const
{
    if (!errorText().isEmpty()) {
        return errorText();
    }

    if (archive()) {
        if (archive()->error() == NoPlugin) {
            return i18n("No suitable plugin found. Ark does not seem to support this file type.");
        }

        if (archive()->error() == FailedPlugin) {
            return i18n("Failed to load a suitable plugin. Make sure any executables needed to handle the archive type are installed.");
        }
    }

    return QString();
}

130 131
void Job::start()
{
132
    jobTimer.start();
133

Elvis Angelaccio's avatar
Elvis Angelaccio committed
134 135 136 137 138 139 140 141
    // We have an archive but it's not valid, nothing to do.
    if (archive() && !archive()->isValid()) {
        QTimer::singleShot(0, this, [=]() {
            onFinished(false);
        });
        return;
    }

142
    if (archiveInterface()->waitForFinishedSignal()) {
143 144 145 146 147 148
        // CLI-based interfaces run a QProcess, no need to use threads.
        QTimer::singleShot(0, this, &Job::doWork);
    } else {
        // Run the job in another thread.
        d->start();
    }
149 150
}

151 152
void Job::connectToArchiveInterfaceSignals()
{
Laurent Montel's avatar
Laurent Montel committed
153 154 155 156 157
    connect(archiveInterface(), &ReadOnlyArchiveInterface::cancelled, this, &Job::onCancelled);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::error, this, &Job::onError);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::entry, this, &Job::onEntry);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::progress, this, &Job::onProgress);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::info, this, &Job::onInfo);
158
    connect(archiveInterface(), &ReadOnlyArchiveInterface::finished, this, &Job::onFinished);
Laurent Montel's avatar
Laurent Montel committed
159
    connect(archiveInterface(), &ReadOnlyArchiveInterface::userQuery, this, &Job::onUserQuery);
160 161 162 163 164

    auto readWriteInterface = qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
    if (readWriteInterface) {
        connect(readWriteInterface, &ReadWriteArchiveInterface::entryRemoved, this, &Job::onEntryRemoved);
    }
165 166
}

167 168
void Job::onCancelled()
{
169
    qCDebug(ARK) << "Cancelled emitted";
170 171 172
    setError(KJob::KilledJobError);
}

173 174
void Job::onError(const QString & message, const QString & details)
{
175
    Q_UNUSED(details)
176

177
    qCDebug(ARK) << "Error emitted:" << message;
178
    setError(KJob::UserDefinedError);
179 180 181
    setErrorText(message);
}

182
void Job::onEntry(Archive::Entry *entry)
183
{
184
    emit newEntry(entry);
185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
}

void Job::onProgress(double value)
{
    setPercent(static_cast<unsigned long>(100.0*value));
}

void Job::onInfo(const QString& info)
{
    emit infoMessage(this, info);
}

void Job::onEntryRemoved(const QString & path)
{
    emit entryRemoved(path);
}

void Job::onFinished(bool result)
{
204
    qCDebug(ARK) << "Job finished, result:" << result << ", time:" << jobTimer.elapsed() << "ms";
205

Elvis Angelaccio's avatar
Elvis Angelaccio committed
206 207 208 209
    if (archive() && !archive()->isValid()) {
        setError(KJob::UserDefinedError);
    }

210 211 212
    if (!d->isInterruptionRequested()) {
        emitResult();
    }
213 214 215 216
}

void Job::onUserQuery(Query *query)
{
217 218 219 220
    if (archiveInterface()->waitForFinishedSignal()) {
        qCWarning(ARK) << "Plugins run from the main thread should call directly query->execute()";
    }

221 222 223 224 225
    emit userQuery(query);
}

bool Job::doKill()
{
Elvis Angelaccio's avatar
Elvis Angelaccio committed
226 227 228 229
    const bool canKillJob = archiveInterface()->doKill();

    if (!d->isRunning()) {
        return canKillJob;
230 231
    }

Elvis Angelaccio's avatar
Elvis Angelaccio committed
232 233 234 235 236 237
    d->requestInterruption();

    if (!canKillJob) {
        qCDebug(ARK) << "Forcing thread exit in one second...";
        d->wait(1000);
        return true;
238
    }
Elvis Angelaccio's avatar
Elvis Angelaccio committed
239 240 241

    d->wait();
    return canKillJob;
242 243
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
244 245
LoadJob::LoadJob(Archive *archive, ReadOnlyArchiveInterface *interface)
    : Job(archive, interface)
246 247 248
    , m_isSingleFolderArchive(true)
    , m_isPasswordProtected(false)
    , m_extractedFilesSize(0)
249 250
    , m_dirCount(0)
    , m_filesCount(0)
251
{
252
    qCDebug(ARK) << "Created job instance";
Elvis Angelaccio's avatar
Elvis Angelaccio committed
253
    connect(this, &LoadJob::newEntry, this, &LoadJob::onNewEntry);
254 255
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
256
LoadJob::LoadJob(Archive *archive)
257
    : LoadJob(archive, nullptr)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
258 259 260
{}

LoadJob::LoadJob(ReadOnlyArchiveInterface *interface)
261
    : LoadJob(nullptr, interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
262 263 264
{}

void LoadJob::doWork()
265
{
266
    emit description(this, i18n("Loading archive"), qMakePair(i18n("Archive"), archiveInterface()->filename()));
267
    connectToArchiveInterfaceSignals();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
268

269
    bool ret = archiveInterface()->list();
270

271
    if (!archiveInterface()->waitForFinishedSignal()) {
272 273 274 275 276
        // onFinished() needs to be called after onNewEntry(), because the former reads members set in the latter.
        // So we need to put it in the event queue, just like the single-thread case does by emitting finished().
        QTimer::singleShot(0, this, [=]() {
            onFinished(ret);
        });
277
    }
278 279
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
280 281
void LoadJob::onFinished(bool result)
{
282
    if (archive() && result) {
Elvis Angelaccio's avatar
Elvis Angelaccio committed
283 284 285 286 287 288 289 290 291 292 293 294 295
        archive()->setProperty("unpackedSize", extractedFilesSize());
        archive()->setProperty("isSingleFolder", isSingleFolderArchive());
        const auto name = subfolderName().isEmpty() ? archive()->completeBaseName() : subfolderName();
        archive()->setProperty("subfolderName", name);
        if (isPasswordProtected()) {
            archive()->setProperty("encryptionType",  archive()->password().isEmpty() ? Archive::Encrypted : Archive::HeaderEncrypted);
        }
    }

    Job::onFinished(result);
}

qlonglong LoadJob::extractedFilesSize() const
296 297 298 299
{
    return m_extractedFilesSize;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
300
bool LoadJob::isPasswordProtected() const
301 302 303 304
{
    return m_isPasswordProtected;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
305
bool LoadJob::isSingleFolderArchive() const
306
{
307 308 309 310
    if (m_filesCount == 1 && m_dirCount == 0) {
        return false;
    }

311 312 313
    return m_isSingleFolderArchive;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
314
void LoadJob::onNewEntry(const Archive::Entry *entry)
315
{
316 317
    m_extractedFilesSize += entry->property("size").toLongLong();
    m_isPasswordProtected |= entry->property("isPasswordProtected").toBool();
318

319
    if (entry->isDir()) {
320 321 322 323 324
        m_dirCount++;
    } else {
        m_filesCount++;
    }

325
    if (m_isSingleFolderArchive) {
326
        // RPM filenames have the ./ prefix, and "." would be detected as the subfolder name, so we remove it.
327
        const QString fullPath = entry->fullPath().replace(QRegularExpression(QStringLiteral("^\\./")), QString());
328
        const QString basePath = fullPath.split(QLatin1Char('/')).at(0);
329

330 331 332
        if (m_basePath.isEmpty()) {
            m_basePath = basePath;
            m_subfolderName = basePath;
333
        } else {
334 335 336 337
            if (m_basePath != basePath) {
                m_isSingleFolderArchive = false;
                m_subfolderName.clear();
            }
338 339 340 341
        }
    }
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
342
QString LoadJob::subfolderName() const
343
{
344 345 346 347
    if (!isSingleFolderArchive()) {
        return QString();
    }

348 349 350
    return m_subfolderName;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
351 352 353 354 355 356 357
BatchExtractJob::BatchExtractJob(LoadJob *loadJob, const QString &destination, bool autoSubfolder, bool preservePaths)
    : Job(loadJob->archive())
    , m_loadJob(loadJob)
    , m_destination(destination)
    , m_autoSubfolder(autoSubfolder)
    , m_preservePaths(preservePaths)
{
358
    qCDebug(ARK) << "Created job instance";
Elvis Angelaccio's avatar
Elvis Angelaccio committed
359 360 361 362 363
}

void BatchExtractJob::doWork()
{
    connect(m_loadJob, &KJob::result, this, &BatchExtractJob::slotLoadingFinished);
364 365
    connect(archiveInterface(), &ReadOnlyArchiveInterface::cancelled, this, &BatchExtractJob::onCancelled);

366 367 368 369
    if (archiveInterface()->hasBatchExtractionProgress()) {
        // progress() will be actually emitted by the LoadJob, but the archiveInterface() is the same.
        connect(archiveInterface(), &ReadOnlyArchiveInterface::progress, this, &BatchExtractJob::slotLoadingProgress);
    }
Elvis Angelaccio's avatar
Elvis Angelaccio committed
370

371
    // Forward LoadJob's signals.
Elvis Angelaccio's avatar
Elvis Angelaccio committed
372 373 374 375 376
    connect(m_loadJob, &Kerfuffle::Job::newEntry, this, &BatchExtractJob::newEntry);
    connect(m_loadJob, &Kerfuffle::Job::userQuery, this, &BatchExtractJob::userQuery);
    m_loadJob->start();
}

377 378 379 380 381 382 383 384 385
bool BatchExtractJob::doKill()
{
    if (m_step == Loading) {
        return m_loadJob->kill();
    }

    return m_extractJob->kill();
}

386 387 388 389 390 391 392 393 394 395 396 397 398
void BatchExtractJob::slotLoadingProgress(double progress)
{
    // Progress from LoadJob counts only for 50% of the BatchExtractJob's duration.
    m_lastPercentage = static_cast<unsigned long>(50.0*progress);
    setPercent(m_lastPercentage);
}

void BatchExtractJob::slotExtractProgress(double progress)
{
    // The 2nd 50% of the BatchExtractJob's duration comes from the ExtractJob.
    setPercent(m_lastPercentage + static_cast<unsigned long>(50.0*progress));
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
399 400 401
void BatchExtractJob::slotLoadingFinished(KJob *job)
{
    if (job->error()) {
402 403 404
        // Forward errors as well.
        onError(job->errorString(), QString());
        onFinished(false);
Elvis Angelaccio's avatar
Elvis Angelaccio committed
405 406 407 408 409 410 411
        return;
    }

    // Now we can start extraction.
    setupDestination();

    Kerfuffle::ExtractionOptions options;
412
    options.setPreservePaths(m_preservePaths);
Elvis Angelaccio's avatar
Elvis Angelaccio committed
413

414 415 416 417
    m_extractJob = archive()->extractFiles({}, m_destination, options);
    if (m_extractJob) {
        connect(m_extractJob, &KJob::result, this, &BatchExtractJob::emitResult);
        connect(m_extractJob, &Kerfuffle::Job::userQuery, this, &BatchExtractJob::userQuery);
418 419 420 421 422
        if (archiveInterface()->hasBatchExtractionProgress()) {
            // The LoadJob is done, change slot and start setting the percentage from m_lastPercentage on.
            disconnect(archiveInterface(), &ReadOnlyArchiveInterface::progress, this, &BatchExtractJob::slotLoadingProgress);
            connect(archiveInterface(), &ReadOnlyArchiveInterface::progress, this, &BatchExtractJob::slotExtractProgress);
        }
423 424
        m_step = Extracting;
        m_extractJob->start();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
    } else {
        emitResult();
    }
}

void BatchExtractJob::setupDestination()
{
    const bool isSingleFolderRPM = (archive()->isSingleFolder() &&
                                   (archive()->mimeType().name() == QLatin1String("application/x-rpm")));

    if (m_autoSubfolder && (!archive()->isSingleFolder() || isSingleFolderRPM)) {
        const QDir d(m_destination);
        QString subfolderName = archive()->subfolderName();

        // Special case for single folder RPM archives.
        // We don't want the autodetected folder to have a meaningless "usr" name.
        if (isSingleFolderRPM && subfolderName == QStringLiteral("usr")) {
            qCDebug(ARK) << "Detected single folder RPM archive. Using archive basename as subfolder name";
            subfolderName = QFileInfo(archive()->fileName()).completeBaseName();
        }

        if (d.exists(subfolderName)) {
            subfolderName = KIO::suggestName(QUrl::fromUserInput(m_destination, QString(), QUrl::AssumeLocalFile), subfolderName);
        }

        d.mkdir(subfolderName);

        m_destination += QLatin1Char( '/' ) + subfolderName;
    }
}

456
CreateJob::CreateJob(Archive *archive, const QVector<Archive::Entry*> &entries, const CompressionOptions &options)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
457 458 459 460
    : Job(archive)
    , m_entries(entries)
    , m_options(options)
{
461
    qCDebug(ARK) << "Created job instance";
Elvis Angelaccio's avatar
Elvis Angelaccio committed
462 463 464 465 466 467 468 469 470 471 472 473 474 475
}

void CreateJob::enableEncryption(const QString &password, bool encryptHeader)
{
    archive()->encrypt(password, encryptHeader);
}

void CreateJob::setMultiVolume(bool isMultiVolume)
{
    archive()->setMultiVolume(isMultiVolume);
}

void CreateJob::doWork()
{
Elvis Angelaccio's avatar
Elvis Angelaccio committed
476
    m_addJob = archive()->addFiles(m_entries, nullptr, m_options);
Elvis Angelaccio's avatar
Elvis Angelaccio committed
477

478 479
    if (m_addJob) {
        connect(m_addJob, &KJob::result, this, &CreateJob::emitResult);
480
        // Forward description signal from AddJob, we need to change the first argument ('this' needs to be a CreateJob).
481
        connect(m_addJob, &KJob::description, this, [=](KJob *, const QString &title, const QPair<QString,QString> &field1, const QPair<QString,QString> &) {
482 483
            emit description(this, title, field1);
        });
484 485 486
        connect(m_addJob, QOverload<KJob*,unsigned long>::of(&KJob::percent), this, [=](KJob*, unsigned long percent) {
            emitPercent(percent, 100);
        });
487

488
        m_addJob->start();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
489 490 491 492 493
    } else {
        emitResult();
    }
}

494 495 496 497 498
bool CreateJob::doKill()
{
    return m_addJob && m_addJob->kill();
}

499
ExtractJob::ExtractJob(const QVector<Archive::Entry*> &entries, const QString &destinationDir, const ExtractionOptions &options, ReadOnlyArchiveInterface *interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
500
    : Job(interface)
501
    , m_entries(entries)
502 503
    , m_destinationDir(destinationDir)
    , m_options(options)
504
{
505
    qCDebug(ARK) << "Created job instance";
506 507 508 509 510
}

void ExtractJob::doWork()
{
    QString desc;
511
    if (m_entries.count() == 0) {
512 513
        desc = i18n("Extracting all files");
    } else {
514
        desc = i18np("Extracting one file", "Extracting %1 files", m_entries.count());
515
    }
516
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()), qMakePair(i18nc("extraction folder", "Destination"), m_destinationDir));
517

518 519 520 521 522 523 524
    QFileInfo destDirInfo(m_destinationDir);
    if (destDirInfo.isDir() && (!destDirInfo.isWritable() || !destDirInfo.isExecutable())) {
        onError(xi18n("Could not write to destination <filename>%1</filename>.<nl/>Check whether you have sufficient permissions.", m_destinationDir), QString());
        onFinished(false);
        return;
    }

525
    connectToArchiveInterfaceSignals();
526

527
    qCDebug(ARK) << "Starting extraction with" << m_entries.count() << "selected files."
528
             << m_entries
529 530
             << "Destination dir:" << m_destinationDir
             << "Options:" << m_options;
531

532
    bool ret = archiveInterface()->extractFiles(m_entries, m_destinationDir, m_options);
533

534
    if (!archiveInterface()->waitForFinishedSignal()) {
535
        onFinished(ret);
536
    }
537 538
}

539 540 541 542 543
QString ExtractJob::destinationDirectory() const
{
    return m_destinationDir;
}

544 545 546 547 548
ExtractionOptions ExtractJob::extractionOptions() const
{
    return m_options;
}

549
TempExtractJob::TempExtractJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
550
    : Job(interface)
551
    , m_entry(entry)
552 553
    , m_passwordProtectedHint(passwordProtectedHint)
{
554
    m_tmpExtractDir = new QTemporaryDir();
555 556 557 558
}

QString TempExtractJob::validatedFilePath() const
{
559
    QString path = extractionDir() + QLatin1Char('/') + m_entry->fullPath();
560 561 562 563 564 565 566 567 568 569 570 571 572 573

    // Make sure a maliciously crafted archive with parent folders named ".." do
    // not cause the previewed file path to be located outside the temporary
    // directory, resulting in a directory traversal issue.
    path.remove(QStringLiteral("../"));

    return path;
}

ExtractionOptions TempExtractJob::extractionOptions() const
{
    ExtractionOptions options;

    if (m_passwordProtectedHint) {
574
        options.setEncryptedArchiveHint(true);
575 576 577 578 579
    }

    return options;
}

580 581 582 583 584
QTemporaryDir *TempExtractJob::tempDir() const
{
    return m_tmpExtractDir;
}

585 586
void TempExtractJob::doWork()
{
587 588
    // pass 1 to i18np on purpose so this translation may properly be reused.
    emit description(this, i18np("Extracting one file", "Extracting %1 files", 1));
589 590 591

    connectToArchiveInterfaceSignals();

592
    qCDebug(ARK) << "Extracting:" << m_entry;
593

594
    bool ret = archiveInterface()->extractFiles({m_entry}, extractionDir(), extractionOptions());
595 596 597 598 599 600

    if (!archiveInterface()->waitForFinishedSignal()) {
        onFinished(ret);
    }
}

601
QString TempExtractJob::extractionDir() const
602
{
603
    return m_tmpExtractDir->path();
604 605
}

606 607
PreviewJob::PreviewJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : TempExtractJob(entry, passwordProtectedHint, interface)
608
{
609
    qCDebug(ARK) << "Created job instance";
610 611
}

612 613
OpenJob::OpenJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : TempExtractJob(entry, passwordProtectedHint, interface)
614
{
615
    qCDebug(ARK) << "Created job instance";
616 617
}

618 619
OpenWithJob::OpenWithJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : OpenJob(entry, passwordProtectedHint, interface)
620
{
621
    qCDebug(ARK) << "Created job instance";
622 623
}

624
AddJob::AddJob(const QVector<Archive::Entry*> &entries, const Archive::Entry *destination, const CompressionOptions& options, ReadWriteArchiveInterface *interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
625
    : Job(interface)
626
    , m_entries(entries)
627
    , m_destination(destination)
628
    , m_options(options)
629
{
630
    qCDebug(ARK) << "Created job instance";
631 632 633 634
}

void AddJob::doWork()
{
635
    // Set current dir.
636
    const QString globalWorkDir = m_options.globalWorkDir();
637 638 639 640 641 642 643
    const QDir workDir = globalWorkDir.isEmpty() ? QDir::current() : QDir(globalWorkDir);
    if (!globalWorkDir.isEmpty()) {
        qCDebug(ARK) << "GlobalWorkDir is set, changing dir to " << globalWorkDir;
        m_oldWorkingDir = QDir::currentPath();
        QDir::setCurrent(globalWorkDir);
    }

644
    // Count total number of entries to be added.
645
    uint totalCount = 0;
646 647
    QElapsedTimer timer;
    timer.start();
648
    for (const Archive::Entry* entry : qAsConst(m_entries)) {
649
        totalCount++;
650
        if (QFileInfo(entry->fullPath()).isDir()) {
651
            QDirIterator it(entry->fullPath(), QDir::AllEntries | QDir::Readable | QDir::Hidden | QDir::NoDotAndDotDot, QDirIterator::Subdirectories);
652 653 654 655 656 657 658
            while (it.hasNext()) {
                it.next();
                totalCount++;
            }
        }
    }

659
    qCDebug(ARK) << "Going to add" << totalCount << "entries, counted in" << timer.elapsed() << "ms";
660

Elvis Angelaccio's avatar
Elvis Angelaccio committed
661
    const QString desc = i18np("Compressing a file", "Compressing %1 files", totalCount);
662
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()));
663 664 665 666 667 668

    ReadWriteArchiveInterface *m_writeInterface =
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());

    Q_ASSERT(m_writeInterface);

669
    // The file paths must be relative to GlobalWorkDir.
670
    for (Archive::Entry *entry : qAsConst(m_entries)) {
671 672
        // #191821: workDir must be used instead of QDir::current()
        //          so that symlinks aren't resolved automatically
673
        const QString &fullPath = entry->fullPath();
674
        QString relativePath = workDir.relativeFilePath(fullPath);
675

676
        if (fullPath.endsWith(QLatin1Char('/'))) {
677 678 679
            relativePath += QLatin1Char('/');
        }

680
        entry->setFullPath(relativePath);
681 682
    }

683
    connectToArchiveInterfaceSignals();
684
    bool ret = m_writeInterface->addFiles(m_entries, m_destination, m_options, totalCount);
685

686
    if (!archiveInterface()->waitForFinishedSignal()) {
687
        onFinished(ret);
688
    }
689 690
}

691 692 693 694 695 696 697 698 699
void AddJob::onFinished(bool result)
{
    if (!m_oldWorkingDir.isEmpty()) {
        QDir::setCurrent(m_oldWorkingDir);
    }

    Job::onFinished(result);
}

700
MoveJob::MoveJob(const QVector<Archive::Entry*> &entries, Archive::Entry *destination, const CompressionOptions& options , ReadWriteArchiveInterface *interface)
701 702 703 704 705 706
    : Job(interface)
    , m_finishedSignalsCount(0)
    , m_entries(entries)
    , m_destination(destination)
    , m_options(options)
{
707
    qCDebug(ARK) << "Created job instance";
708 709 710 711
}

void MoveJob::doWork()
{
712
    qCDebug(ARK) << "Going to move" << m_entries.count() << "file(s)";
713

714 715
    QString desc = i18np("Moving a file", "Moving %1 files", m_entries.count());
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()));
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737

    ReadWriteArchiveInterface *m_writeInterface =
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());

    Q_ASSERT(m_writeInterface);

    connectToArchiveInterfaceSignals();
    bool ret = m_writeInterface->moveFiles(m_entries, m_destination, m_options);

    if (!archiveInterface()->waitForFinishedSignal()) {
        onFinished(ret);
    }
}

void MoveJob::onFinished(bool result)
{
    m_finishedSignalsCount++;
    if (m_finishedSignalsCount == archiveInterface()->moveRequiredSignals()) {
        Job::onFinished(result);
    }
}

738
CopyJob::CopyJob(const QVector<Archive::Entry*> &entries, Archive::Entry *destination, const CompressionOptions &options, ReadWriteArchiveInterface *interface)
739 740 741 742 743 744
    : Job(interface)
    , m_finishedSignalsCount(0)
    , m_entries(entries)
    , m_destination(destination)
    , m_options(options)
{
745
    qCDebug(ARK) << "Created job instance";
746 747 748 749
}

void CopyJob::doWork()
{
750
    qCDebug(ARK) << "Going to copy" << m_entries.count() << "file(s)";
751

752 753
    QString desc = i18np("Copying a file", "Copying %1 files", m_entries.count());
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()));
754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775

    ReadWriteArchiveInterface *m_writeInterface =
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());

    Q_ASSERT(m_writeInterface);

    connectToArchiveInterfaceSignals();
    bool ret = m_writeInterface->copyFiles(m_entries, m_destination, m_options);

    if (!archiveInterface()->waitForFinishedSignal()) {
        onFinished(ret);
    }
}

void CopyJob::onFinished(bool result)
{
    m_finishedSignalsCount++;
    if (m_finishedSignalsCount == archiveInterface()->copyRequiredSignals()) {
        Job::onFinished(result);
    }
}

776
DeleteJob::DeleteJob(const QVector<Archive::Entry*> &entries, ReadWriteArchiveInterface *interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
777
    : Job(interface)
778
    , m_entries(entries)
779 780 781 782 783
{
}

void DeleteJob::doWork()
{
784 785
    QString desc = i18np("Deleting a file from the archive", "Deleting %1 files", m_entries.count());
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()));
786 787

    ReadWriteArchiveInterface *m_writeInterface =
788
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
789 790 791

    Q_ASSERT(m_writeInterface);

792
    connectToArchiveInterfaceSignals();
793
    bool ret = m_writeInterface->deleteFiles(m_entries);
794

795
    if (!archiveInterface()->waitForFinishedSignal()) {
796
        onFinished(ret);
797
    }
798
}
799

Elvis Angelaccio's avatar
Elvis Angelaccio committed
800 801
CommentJob::CommentJob(const QString& comment, ReadWriteArchiveInterface *interface)
    : Job(interface)
802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822
    , m_comment(comment)
{
}

void CommentJob::doWork()
{
    emit description(this, i18n("Adding comment"));

    ReadWriteArchiveInterface *m_writeInterface =
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());

    Q_ASSERT(m_writeInterface);

    connectToArchiveInterfaceSignals();
    bool ret = m_writeInterface->addComment(m_comment);

    if (!archiveInterface()->waitForFinishedSignal()) {
        onFinished(ret);
    }
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
823 824
TestJob::TestJob(ReadOnlyArchiveInterface *interface)
    : Job(interface)
Ragnar Thomsen's avatar
Ragnar Thomsen committed
825 826 827 828 829 830
{
    m_testSuccess = false;
}

void TestJob::doWork()
{
831
    qCDebug(ARK) << "Job started";
Ragnar Thomsen's avatar
Ragnar Thomsen committed
832

833 834
    emit description(this, i18n("Testing archive"), qMakePair(i18n("Archive"), archiveInterface()->filename()));

Ragnar Thomsen's avatar
Ragnar Thomsen committed
835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
    connectToArchiveInterfaceSignals();
    connect(archiveInterface(), &ReadOnlyArchiveInterface::testSuccess, this, &TestJob::onTestSuccess);

    bool ret = archiveInterface()->testArchive();

    if (!archiveInterface()->waitForFinishedSignal()) {
        onFinished(ret);
    }
}

void TestJob::onTestSuccess()
{
    m_testSuccess = true;
}

bool TestJob::testSucceeded()
{
    return m_testSuccess;
}

855
} // namespace Kerfuffle
856

Elvis Angelaccio's avatar
Elvis Angelaccio committed
857
#include "jobs.moc"