jobs.cpp 24.5 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 213 214
    emitResult();
}

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

219 220 221 222 223
    emit userQuery(query);
}

bool Job::doKill()
{
224 225 226 227 228
    if (d->isRunning()) {
        d->requestInterruption();
        d->wait();
    }

229
    bool ret = archiveInterface()->doKill();
230
    if (!ret) {
231
        qCWarning(ARK) << "Killing does not seem to be supported here.";
232
    }
233 234 235
    return ret;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
236 237
LoadJob::LoadJob(Archive *archive, ReadOnlyArchiveInterface *interface)
    : Job(archive, interface)
238 239 240
    , m_isSingleFolderArchive(true)
    , m_isPasswordProtected(false)
    , m_extractedFilesSize(0)
241 242
    , m_dirCount(0)
    , m_filesCount(0)
243
{
244
    qCDebug(ARK) << "LoadJob created";
Elvis Angelaccio's avatar
Elvis Angelaccio committed
245
    connect(this, &LoadJob::newEntry, this, &LoadJob::onNewEntry);
246 247
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
248
LoadJob::LoadJob(Archive *archive)
249
    : LoadJob(archive, nullptr)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
250 251 252
{}

LoadJob::LoadJob(ReadOnlyArchiveInterface *interface)
253
    : LoadJob(nullptr, interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
254 255 256
{}

void LoadJob::doWork()
257
{
258
    emit description(this, i18n("Loading archive"), qMakePair(i18n("Archive"), archiveInterface()->filename()));
259
    connectToArchiveInterfaceSignals();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
260

261
    bool ret = archiveInterface()->list();
262

263
    if (!archiveInterface()->waitForFinishedSignal()) {
264 265 266 267 268
        // 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);
        });
269
    }
270 271
}

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

Elvis Angelaccio's avatar
Elvis Angelaccio committed
292
bool LoadJob::isPasswordProtected() const
293 294 295 296
{
    return m_isPasswordProtected;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
297
bool LoadJob::isSingleFolderArchive() const
298
{
299 300 301 302
    if (m_filesCount == 1 && m_dirCount == 0) {
        return false;
    }

303 304 305
    return m_isSingleFolderArchive;
}

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

311
    if (entry->isDir()) {
312 313 314 315 316
        m_dirCount++;
    } else {
        m_filesCount++;
    }

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

322 323 324
        if (m_basePath.isEmpty()) {
            m_basePath = basePath;
            m_subfolderName = basePath;
325
        } else {
326 327 328 329
            if (m_basePath != basePath) {
                m_isSingleFolderArchive = false;
                m_subfolderName.clear();
            }
330 331 332 333
        }
    }
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
334
QString LoadJob::subfolderName() const
335
{
336 337 338 339
    if (!isSingleFolderArchive()) {
        return QString();
    }

340 341 342
    return m_subfolderName;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
343 344 345 346 347 348 349 350 351 352 353 354 355
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)
{
    qCDebug(ARK) << "BatchExtractJob created";
}

void BatchExtractJob::doWork()
{
    connect(m_loadJob, &KJob::result, this, &BatchExtractJob::slotLoadingFinished);
356 357 358 359
    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
360

361
    // Forward LoadJob's signals.
Elvis Angelaccio's avatar
Elvis Angelaccio committed
362 363 364 365 366
    connect(m_loadJob, &Kerfuffle::Job::newEntry, this, &BatchExtractJob::newEntry);
    connect(m_loadJob, &Kerfuffle::Job::userQuery, this, &BatchExtractJob::userQuery);
    m_loadJob->start();
}

367 368 369 370 371 372 373 374 375
bool BatchExtractJob::doKill()
{
    if (m_step == Loading) {
        return m_loadJob->kill();
    }

    return m_extractJob->kill();
}

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

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

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

404 405 406 407
    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);
408 409 410 411 412
        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);
        }
413 414
        m_step = Extracting;
        m_extractJob->start();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
    } 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;
    }
}

446
CreateJob::CreateJob(Archive *archive, const QVector<Archive::Entry*> &entries, const CompressionOptions &options)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
    : Job(archive)
    , m_entries(entries)
    , m_options(options)
{
    qCDebug(ARK) << "CreateJob created";
}

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

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

void CreateJob::doWork()
{
466
    m_addJob = archive()->addFiles(m_entries, new Archive::Entry(this), m_options);
Elvis Angelaccio's avatar
Elvis Angelaccio committed
467

468 469
    if (m_addJob) {
        connect(m_addJob, &KJob::result, this, &CreateJob::emitResult);
470
        // Forward description signal from AddJob, we need to change the first argument ('this' needs to be a CreateJob).
471
        connect(m_addJob, &KJob::description, this, [=](KJob *, const QString &title, const QPair<QString,QString> &field1, const QPair<QString,QString> &) {
472 473 474
            emit description(this, title, field1);
        });

475
        m_addJob->start();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
476 477 478 479 480
    } else {
        emitResult();
    }
}

481 482 483 484 485
bool CreateJob::doKill()
{
    return m_addJob && m_addJob->kill();
}

486
ExtractJob::ExtractJob(const QVector<Archive::Entry*> &entries, const QString &destinationDir, const ExtractionOptions &options, ReadOnlyArchiveInterface *interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
487
    : Job(interface)
488
    , m_entries(entries)
489 490
    , m_destinationDir(destinationDir)
    , m_options(options)
491
{
492
    qCDebug(ARK) << "ExtractJob created";
493 494 495 496 497
}

void ExtractJob::doWork()
{
    QString desc;
498
    if (m_entries.count() == 0) {
499 500
        desc = i18n("Extracting all files");
    } else {
501
        desc = i18np("Extracting one file", "Extracting %1 files", m_entries.count());
502
    }
503
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()), qMakePair(i18nc("extraction folder", "Destination"), m_destinationDir));
504

505 506 507 508 509 510 511
    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;
    }

512
    connectToArchiveInterfaceSignals();
513

514
    qCDebug(ARK) << "Starting extraction with" << m_entries.count() << "selected files."
515
             << m_entries
516 517
             << "Destination dir:" << m_destinationDir
             << "Options:" << m_options;
518

519
    bool ret = archiveInterface()->extractFiles(m_entries, m_destinationDir, m_options);
520

521
    if (!archiveInterface()->waitForFinishedSignal()) {
522
        onFinished(ret);
523
    }
524 525
}

526 527 528 529 530
QString ExtractJob::destinationDirectory() const
{
    return m_destinationDir;
}

531 532 533 534 535
ExtractionOptions ExtractJob::extractionOptions() const
{
    return m_options;
}

536
TempExtractJob::TempExtractJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
537
    : Job(interface)
538
    , m_entry(entry)
539 540
    , m_passwordProtectedHint(passwordProtectedHint)
{
541
    m_tmpExtractDir = new QTemporaryDir();
542 543 544 545
}

QString TempExtractJob::validatedFilePath() const
{
546
    QString path = extractionDir() + QLatin1Char('/') + m_entry->fullPath();
547 548 549 550 551 552 553 554 555 556 557 558 559 560

    // 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) {
561
        options.setEncryptedArchiveHint(true);
562 563 564 565 566
    }

    return options;
}

567 568 569 570 571
QTemporaryDir *TempExtractJob::tempDir() const
{
    return m_tmpExtractDir;
}

572 573
void TempExtractJob::doWork()
{
574 575
    // pass 1 to i18np on purpose so this translation may properly be reused.
    emit description(this, i18np("Extracting one file", "Extracting %1 files", 1));
576 577 578

    connectToArchiveInterfaceSignals();

579
    qCDebug(ARK) << "Extracting:" << m_entry;
580

581
    bool ret = archiveInterface()->extractFiles({m_entry}, extractionDir(), extractionOptions());
582 583 584 585 586 587

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

588
QString TempExtractJob::extractionDir() const
589
{
590
    return m_tmpExtractDir->path();
591 592
}

593 594
PreviewJob::PreviewJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : TempExtractJob(entry, passwordProtectedHint, interface)
595
{
596
    qCDebug(ARK) << "PreviewJob created";
597 598
}

599 600
OpenJob::OpenJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : TempExtractJob(entry, passwordProtectedHint, interface)
601
{
602
    qCDebug(ARK) << "OpenJob created";
603 604
}

605 606
OpenWithJob::OpenWithJob(Archive::Entry *entry, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : OpenJob(entry, passwordProtectedHint, interface)
607
{
608
    qCDebug(ARK) << "OpenWithJob created";
609 610
}

611
AddJob::AddJob(const QVector<Archive::Entry*> &entries, const Archive::Entry *destination, const CompressionOptions& options, ReadWriteArchiveInterface *interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
612
    : Job(interface)
613
    , m_entries(entries)
614
    , m_destination(destination)
615
    , m_options(options)
616
{
617
    qCDebug(ARK) << "AddJob created";
618 619 620 621
}

void AddJob::doWork()
{
622
    // Set current dir.
623
    const QString globalWorkDir = m_options.globalWorkDir();
624 625 626 627 628 629 630
    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);
    }

631
    // Count total number of entries to be added.
632
    uint totalCount = 0;
633 634
    QElapsedTimer timer;
    timer.start();
635
    foreach (const Archive::Entry* entry, m_entries) {
636
        totalCount++;
637
        if (QFileInfo(entry->fullPath()).isDir()) {
638
            QDirIterator it(entry->fullPath(), QDir::AllEntries | QDir::Readable | QDir::Hidden | QDir::NoDotAndDotDot, QDirIterator::Subdirectories);
639 640 641 642 643 644 645
            while (it.hasNext()) {
                it.next();
                totalCount++;
            }
        }
    }

646
    qCDebug(ARK) << "AddJob: going to add" << totalCount << "entries, counted in" << timer.elapsed() << "ms";
647

Elvis Angelaccio's avatar
Elvis Angelaccio committed
648
    const QString desc = i18np("Compressing a file", "Compressing %1 files", totalCount);
649
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()));
650 651 652 653 654 655

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

    Q_ASSERT(m_writeInterface);

656
    // The file paths must be relative to GlobalWorkDir.
657
    foreach (Archive::Entry *entry, m_entries) {
658 659
        // #191821: workDir must be used instead of QDir::current()
        //          so that symlinks aren't resolved automatically
660
        const QString &fullPath = entry->fullPath();
661
        QString relativePath = workDir.relativeFilePath(fullPath);
662

663
        if (fullPath.endsWith(QLatin1Char('/'))) {
664 665 666
            relativePath += QLatin1Char('/');
        }

667
        entry->setFullPath(relativePath);
668 669
    }

670
    connectToArchiveInterfaceSignals();
671
    bool ret = m_writeInterface->addFiles(m_entries, m_destination, m_options, totalCount);
672

673
    if (!archiveInterface()->waitForFinishedSignal()) {
674
        onFinished(ret);
675
    }
676 677
}

678 679 680 681 682 683 684 685 686
void AddJob::onFinished(bool result)
{
    if (!m_oldWorkingDir.isEmpty()) {
        QDir::setCurrent(m_oldWorkingDir);
    }

    Job::onFinished(result);
}

687
MoveJob::MoveJob(const QVector<Archive::Entry*> &entries, Archive::Entry *destination, const CompressionOptions& options , ReadWriteArchiveInterface *interface)
688 689 690 691 692 693
    : Job(interface)
    , m_finishedSignalsCount(0)
    , m_entries(entries)
    , m_destination(destination)
    , m_options(options)
{
694
    qCDebug(ARK) << "MoveJob created";
695 696 697 698 699 700
}

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

701 702
    QString desc = i18np("Moving a file", "Moving %1 files", m_entries.count());
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()));
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724

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

725
CopyJob::CopyJob(const QVector<Archive::Entry*> &entries, Archive::Entry *destination, const CompressionOptions &options, ReadWriteArchiveInterface *interface)
726 727 728 729 730 731
    : Job(interface)
    , m_finishedSignalsCount(0)
    , m_entries(entries)
    , m_destination(destination)
    , m_options(options)
{
732
    qCDebug(ARK) << "CopyJob created";
733 734 735 736 737 738
}

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

739 740
    QString desc = i18np("Copying a file", "Copying %1 files", m_entries.count());
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()));
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762

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

763
DeleteJob::DeleteJob(const QVector<Archive::Entry*> &entries, ReadWriteArchiveInterface *interface)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
764
    : Job(interface)
765
    , m_entries(entries)
766 767 768 769 770
{
}

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

    ReadWriteArchiveInterface *m_writeInterface =
775
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
776 777 778

    Q_ASSERT(m_writeInterface);

779
    connectToArchiveInterfaceSignals();
780
    bool ret = m_writeInterface->deleteFiles(m_entries);
781

782
    if (!archiveInterface()->waitForFinishedSignal()) {
783
        onFinished(ret);
784
    }
785
}
786

Elvis Angelaccio's avatar
Elvis Angelaccio committed
787 788
CommentJob::CommentJob(const QString& comment, ReadWriteArchiveInterface *interface)
    : Job(interface)
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809
    , 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
810 811
TestJob::TestJob(ReadOnlyArchiveInterface *interface)
    : Job(interface)
Ragnar Thomsen's avatar
Ragnar Thomsen committed
812 813 814 815 816 817 818 819
{
    m_testSuccess = false;
}

void TestJob::doWork()
{
    qCDebug(ARK) << "TestJob started";

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

Ragnar Thomsen's avatar
Ragnar Thomsen committed
822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
    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;
}

842
} // namespace Kerfuffle
843

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