jobs.cpp 24.4 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:
52 53 54 55 56 57
    Private(Job *job, QObject *parent = 0)
        : QThread(parent)
        , q(job)
    {
    }

58
    virtual void run() Q_DECL_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 79 80 81 82 83 84 85
Job::Job(Archive *archive)
    : Job(archive, Q_NULLPTR)
{}

Job::Job(ReadOnlyArchiveInterface *interface)
    : Job(Q_NULLPTR, interface)
{}

86 87
Job::~Job()
{
88 89 90
    qDeleteAll(m_archiveEntries);
    m_archiveEntries.clear();

91 92
    if (d->isRunning()) {
        d->wait();
93 94
    }

95
    delete d;
96
}
97

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

    // Use the interface passed to this job (e.g. JSONArchiveInterface in jobstest.cpp).
106 107 108
    return m_archiveInterface;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
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();
}

133 134
void Job::start()
{
135
    jobTimer.start();
136

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

145
    if (archiveInterface()->waitForFinishedSignal()) {
146 147 148 149 150 151
        // 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();
    }
152 153
}

154 155
void Job::connectToArchiveInterfaceSignals()
{
Laurent Montel's avatar
Laurent Montel committed
156 157 158 159 160
    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);
161
    connect(archiveInterface(), &ReadOnlyArchiveInterface::finished, this, &Job::onFinished);
Laurent Montel's avatar
Laurent Montel committed
162
    connect(archiveInterface(), &ReadOnlyArchiveInterface::userQuery, this, &Job::onUserQuery);
163 164 165 166 167

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

170 171
void Job::onCancelled()
{
172
    qCDebug(ARK) << "Cancelled emitted";
173 174 175
    setError(KJob::KilledJobError);
}

176 177
void Job::onError(const QString & message, const QString & details)
{
178
    Q_UNUSED(details)
179

180
    qCDebug(ARK) << "Error emitted:" << message;
181
    setError(KJob::UserDefinedError);
182 183 184
    setErrorText(message);
}

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

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)
{
207
    qCDebug(ARK) << "Job finished, result:" << result << ", time:" << jobTimer.elapsed() << "ms";
208

Elvis Angelaccio's avatar
Elvis Angelaccio committed
209 210 211 212
    if (archive() && !archive()->isValid()) {
        setError(KJob::UserDefinedError);
    }

213 214 215 216 217
    emitResult();
}

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

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

bool Job::doKill()
{
227 228 229 230 231
    if (d->isRunning()) {
        d->requestInterruption();
        d->wait();
    }

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

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

Elvis Angelaccio's avatar
Elvis Angelaccio committed
251 252 253 254 255 256 257 258 259
LoadJob::LoadJob(Archive *archive)
    : LoadJob(archive, Q_NULLPTR)
{}

LoadJob::LoadJob(ReadOnlyArchiveInterface *interface)
    : LoadJob(Q_NULLPTR, interface)
{}

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

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

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

Elvis Angelaccio's avatar
Elvis Angelaccio committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
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
291 292 293 294
{
    return m_extractedFilesSize;
}

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

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

306 307 308
    return m_isSingleFolderArchive;
}

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

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

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

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

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

343 344 345
    return m_subfolderName;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
346 347 348 349 350 351 352 353 354 355 356 357 358
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);
359 360 361 362
    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
363

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

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

    return m_extractJob->kill();
}

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

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

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

407 408 409 410
    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);
411 412 413 414 415
        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);
        }
416 417
        m_step = Extracting;
        m_extractJob->start();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
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 446 447 448
    } 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;
    }
}

449
CreateJob::CreateJob(Archive *archive, const QVector<Archive::Entry*> &entries, const CompressionOptions &options)
Elvis Angelaccio's avatar
Elvis Angelaccio committed
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468
    : 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()
{
469
    m_addJob = archive()->addFiles(m_entries, new Archive::Entry(this), m_options);
Elvis Angelaccio's avatar
Elvis Angelaccio committed
470

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

478
        m_addJob->start();
Elvis Angelaccio's avatar
Elvis Angelaccio committed
479 480 481 482 483
    } else {
        emitResult();
    }
}

484 485 486 487 488
bool CreateJob::doKill()
{
    return m_addJob && m_addJob->kill();
}

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

void ExtractJob::doWork()
{
    QString desc;
501
    if (m_entries.count() == 0) {
502 503
        desc = i18n("Extracting all files");
    } else {
504
        desc = i18np("Extracting one file", "Extracting %1 files", m_entries.count());
505
    }
506
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()));
507

508 509 510 511 512 513 514
    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;
    }

515
    connectToArchiveInterfaceSignals();
516

517
    qCDebug(ARK) << "Starting extraction with" << m_entries.count() << "selected files."
518
             << m_entries
519 520
             << "Destination dir:" << m_destinationDir
             << "Options:" << m_options;
521

522
    bool ret = archiveInterface()->extractFiles(m_entries, m_destinationDir, m_options);
523

524
    if (!archiveInterface()->waitForFinishedSignal()) {
525
        onFinished(ret);
526
    }
527 528
}

529 530 531 532 533
QString ExtractJob::destinationDirectory() const
{
    return m_destinationDir;
}

534 535 536 537 538
ExtractionOptions ExtractJob::extractionOptions() const
{
    return m_options;
}

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

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

    // 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) {
564
        options.setEncryptedArchiveHint(true);
565 566 567 568 569
    }

    return options;
}

570 571 572 573 574
QTemporaryDir *TempExtractJob::tempDir() const
{
    return m_tmpExtractDir;
}

575 576 577 578 579 580
void TempExtractJob::doWork()
{
    emit description(this, i18n("Extracting one file"));

    connectToArchiveInterfaceSignals();

581
    qCDebug(ARK) << "Extracting:" << m_entry;
582

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

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

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

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

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

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

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

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

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

648
    qCDebug(ARK) << "AddJob: going to add" << totalCount << "entries, counted in" << timer.elapsed() << "ms";
649 650 651

    QString desc = i18np("Adding a file", "Adding %1 files", totalCount);
    emit description(this, desc, qMakePair(i18n("Archive"), archiveInterface()->filename()));
652 653 654 655 656 657

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

    Q_ASSERT(m_writeInterface);

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

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

669
        entry->setFullPath(relativePath);
670 671
    }

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

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

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

    Job::onFinished(result);
}

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

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

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

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

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

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

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

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

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

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

    ReadWriteArchiveInterface *m_writeInterface =
777
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
778 779 780

    Q_ASSERT(m_writeInterface);

781
    connectToArchiveInterfaceSignals();
782
    bool ret = m_writeInterface->deleteFiles(m_entries);
783

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

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

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

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

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

844
} // namespace Kerfuffle
845

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