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

41
#include <KFileUtils>
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
    const bool killed = archiveInterface()->doKill();
    if (killed) {
        return true;
229 230
    }

Elvis Angelaccio's avatar
Elvis Angelaccio committed
231 232 233
    if (d->isRunning()) {
        qCDebug(ARK) << "Requesting graceful thread interruption, will abort in one second otherwise.";
        d->requestInterruption();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
234
        d->wait(1000);
235
    }
Elvis Angelaccio's avatar
Elvis Angelaccio committed
236

Elvis Angelaccio's avatar
Elvis Angelaccio committed
237
    return true;
238 239
}

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

Elvis Angelaccio's avatar
Elvis Angelaccio committed
252
LoadJob::LoadJob(Archive *archive)
253
    : LoadJob(archive, nullptr)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
254 255 256
{}

LoadJob::LoadJob(ReadOnlyArchiveInterface *interface)
257
    : LoadJob(nullptr, interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
258 259 260
{}

void LoadJob::doWork()
261
{
262
    emit description(this, i18n("Loading archive"), qMakePair(i18n("Archive"), archiveInterface()->filename()));
263
    connectToArchiveInterfaceSignals();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
264

265
    bool ret = archiveInterface()->list();
266

267
    if (!archiveInterface()->waitForFinishedSignal()) {
268 269 270 271 272
        // 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);
        });
273
    }
274 275
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
276 277
void LoadJob::onFinished(bool result)
{
278
    if (archive() && result) {
Elvis Angelaccio's avatar
Elvis Angelaccio committed
279 280 281 282 283 284 285 286 287 288 289 290 291
        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
292 293 294 295
{
    return m_extractedFilesSize;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
296
bool LoadJob::isPasswordProtected() const
297 298 299 300
{
    return m_isPasswordProtected;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
301
bool LoadJob::isSingleFolderArchive() const
302
{
303 304 305 306
    if (m_filesCount == 1 && m_dirCount == 0) {
        return false;
    }

307 308 309
    return m_isSingleFolderArchive;
}

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

315
    if (entry->isDir()) {
316 317 318 319 320
        m_dirCount++;
    } else {
        m_filesCount++;
    }

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

326 327 328
        if (m_basePath.isEmpty()) {
            m_basePath = basePath;
            m_subfolderName = basePath;
329
        } else {
330 331 332 333
            if (m_basePath != basePath) {
                m_isSingleFolderArchive = false;
                m_subfolderName.clear();
            }
334 335 336 337
        }
    }
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
338
QString LoadJob::subfolderName() const
339
{
340 341 342 343
    if (!isSingleFolderArchive()) {
        return QString();
    }

344 345 346
    return m_subfolderName;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
347 348 349 350 351 352 353
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)
{
354
    qCDebug(ARK) << "Created job instance";
Elvis Angelaccio's avatar
Elvis Angelaccio committed
355 356 357 358 359
}

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

362 363 364 365
    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
366

367
    // Forward LoadJob's signals.
Elvis Angelaccio's avatar
Elvis Angelaccio committed
368 369 370 371 372
    connect(m_loadJob, &Kerfuffle::Job::newEntry, this, &BatchExtractJob::newEntry);
    connect(m_loadJob, &Kerfuffle::Job::userQuery, this, &BatchExtractJob::userQuery);
    m_loadJob->start();
}

373 374 375 376 377 378 379 380 381
bool BatchExtractJob::doKill()
{
    if (m_step == Loading) {
        return m_loadJob->kill();
    }

    return m_extractJob->kill();
}

382 383 384 385 386 387 388 389 390 391 392 393 394
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
395 396 397
void BatchExtractJob::slotLoadingFinished(KJob *job)
{
    if (job->error()) {
398 399 400
        // Forward errors as well.
        onError(job->errorString(), QString());
        onFinished(false);
Elvis Angelaccio's avatar
Elvis Angelaccio committed
401 402 403 404 405 406 407
        return;
    }

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

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

410 411 412 413
    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);
414
        connect(archiveInterface(), &ReadOnlyArchiveInterface::error, this, &BatchExtractJob::onError);
415 416 417 418 419
        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);
        }
420 421
        m_step = Extracting;
        m_extractJob->start();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
422 423 424 425 426 427 428 429 430 431
    } else {
        emitResult();
    }
}

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

432
    if (m_autoSubfolder && (archive()->hasMultipleTopLevelEntries() || isSingleFolderRPM)) {
Elvis Angelaccio's avatar
Elvis Angelaccio committed
433 434 435 436 437
        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.
438
        if (isSingleFolderRPM && subfolderName == QLatin1String("usr")) {
Elvis Angelaccio's avatar
Elvis Angelaccio committed
439 440 441 442 443
            qCDebug(ARK) << "Detected single folder RPM archive. Using archive basename as subfolder name";
            subfolderName = QFileInfo(archive()->fileName()).completeBaseName();
        }

        if (d.exists(subfolderName)) {
444
            subfolderName = KFileUtils::suggestName(QUrl::fromUserInput(m_destination, QString(), QUrl::AssumeLocalFile), subfolderName);
Elvis Angelaccio's avatar
Elvis Angelaccio committed
445 446 447 448 449 450 451 452
        }

        d.mkdir(subfolderName);

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

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

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

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

void CreateJob::doWork()
{
473 474
    connect(archiveInterface(), &ReadOnlyArchiveInterface::progress, this, &CreateJob::onProgress);

Elvis Angelaccio's avatar
Elvis Angelaccio committed
475
    m_addJob = archive()->addFiles(m_entries, nullptr, m_options);
Elvis Angelaccio's avatar
Elvis Angelaccio committed
476

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

484
        m_addJob->start();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
485 486 487 488 489
    } else {
        emitResult();
    }
}

490 491 492 493 494
bool CreateJob::doKill()
{
    return m_addJob && m_addJob->kill();
}

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

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

514 515 516 517 518 519 520
    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;
    }

521
    connectToArchiveInterfaceSignals();
522

523
    qCDebug(ARK) << "Starting extraction with" << m_entries.count() << "selected files."
524
             << m_entries
525 526
             << "Destination dir:" << m_destinationDir
             << "Options:" << m_options;
527

528
    bool ret = archiveInterface()->extractFiles(m_entries, m_destinationDir, m_options);
529

530
    if (!archiveInterface()->waitForFinishedSignal()) {
531
        onFinished(ret);
532
    }
533 534
}

535 536 537 538 539
QString ExtractJob::destinationDirectory() const
{
    return m_destinationDir;
}

540 541 542 543 544
ExtractionOptions ExtractJob::extractionOptions() const
{
    return m_options;
}

545
TempExtractJob::TempExtractJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
546
    : Job(interface)
547
    , m_entry(entry)
548 549
    , m_passwordProtectedHint(passwordProtectedHint)
{
550
    m_tmpExtractDir = new QTemporaryDir();
551 552 553 554
}

QString TempExtractJob::validatedFilePath() const
{
555
    QString path = extractionDir() + QLatin1Char('/') + m_entry->fullPath();
556 557 558 559 560 561 562 563 564 565 566 567 568 569

    // 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) {
570
        options.setEncryptedArchiveHint(true);
571 572 573 574 575
    }

    return options;
}

576 577 578 579 580
QTemporaryDir *TempExtractJob::tempDir() const
{
    return m_tmpExtractDir;
}

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

    connectToArchiveInterfaceSignals();

588
    qCDebug(ARK) << "Extracting:" << m_entry;
589

590
    bool ret = archiveInterface()->extractFiles({m_entry}, extractionDir(), extractionOptions());
591 592 593 594 595 596

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

597
QString TempExtractJob::extractionDir() const
598
{
599
    return m_tmpExtractDir->path();
600 601
}

602 603
PreviewJob::PreviewJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : TempExtractJob(entry, passwordProtectedHint, interface)
604
{
605
    qCDebug(ARK) << "Created job instance";
606 607
}

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

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

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

void AddJob::doWork()
{
631
    // Set current dir.
632
    const QString globalWorkDir = m_options.globalWorkDir();
633 634 635 636 637 638 639
    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);
    }

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

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

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

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

    Q_ASSERT(m_writeInterface);

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

672
        if (fullPath.endsWith(QLatin1Char('/'))) {
673 674 675
            relativePath += QLatin1Char('/');
        }

676
        entry->setFullPath(relativePath);
677 678
    }

679
    connectToArchiveInterfaceSignals();
680
    bool ret = m_writeInterface->addFiles(m_entries, m_destination, m_options, totalCount);
681

682
    if (!archiveInterface()->waitForFinishedSignal()) {
683
        onFinished(ret);
684
    }
685 686
}

687 688 689 690 691 692 693 694 695
void AddJob::onFinished(bool result)
{
    if (!m_oldWorkingDir.isEmpty()) {
        QDir::setCurrent(m_oldWorkingDir);
    }

    Job::onFinished(result);
}

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

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

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

    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);
    }
}

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

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

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

    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);
    }
}

772
DeleteJob::DeleteJob(const QVector<Archive::Entry*> &entries, ReadWriteArchiveInterface *interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
773
    : Job(interface)
774
    , m_entries(entries)
775 776 777 778 779
{
}

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

    ReadWriteArchiveInterface *m_writeInterface =
784
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
785 786 787

    Q_ASSERT(m_writeInterface);

788
    connectToArchiveInterfaceSignals();
789
    bool ret = m_writeInterface->deleteFiles(m_entries);
790

791
    if (!archiveInterface()->waitForFinishedSignal()) {
792
        onFinished(ret);
793
    }
794
}
795

Elvis Angelaccio's avatar
Elvis Angelaccio committed
796 797
CommentJob::CommentJob(const QString& comment, ReadWriteArchiveInterface *interface)
    : Job(interface)
798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818
    , 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
819 820
TestJob::TestJob(ReadOnlyArchiveInterface *interface)
    : Job(interface)
Ragnar Thomsen's avatar
Ragnar Thomsen committed
821 822 823 824 825 826
{
    m_testSuccess = false;
}

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

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

Ragnar Thomsen's avatar
Ragnar Thomsen committed
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
    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;
}

851
} // namespace Kerfuffle
852

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