jobs.cpp 14.3 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 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
 *
 * 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.
 */
27

28
#include "jobs.h"
29
#include "ark_debug.h"
30

31
#include <QDir>
32
#include <QFileInfo>
33
#include <QRegularExpression>
34
#include <QThread>
35
#include <QTimer>
36

37
#include <KLocalizedString>
38

39 40
//#define DEBUG_RACECONDITION

41 42
namespace Kerfuffle
{
43

44 45 46
class Job::Private : public QThread
{
public:
47 48 49 50
    Private(Job *job, QObject *parent = 0)
        : QThread(parent)
        , q(job)
    {
Laurent Montel's avatar
Laurent Montel committed
51
        connect(q, &KJob::result, this, &QThread::quit);
52 53
    }

54
    virtual void run() Q_DECL_OVERRIDE;
55

56
private:
57 58 59 60 61
    Job *q;
};

void Job::Private::run()
{
62
    q->doWork();
63

64 65 66
    if (q->isRunning()) {
        exec();
    }
67 68 69 70 71 72

#ifdef DEBUG_RACECONDITION
    QThread::sleep(2);
#endif
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
73 74
Job::Job(ReadOnlyArchiveInterface *interface)
    : KJob()
75
    , m_archiveInterface(interface)
76 77
    , m_isRunning(false)
    , d(new Private(this))
78 79 80 81 82 83 84 85 86 87 88 89
{
    static bool onlyOnce = false;
    if (!onlyOnce) {
        qRegisterMetaType<QPair<QString, QString> >("QPair<QString,QString>");
        onlyOnce = true;
    }

    setCapabilities(KJob::Killable);
}

Job::~Job()
{
90 91
    if (d->isRunning()) {
        d->wait();
92 93
    }

94
    delete d;
95
}
96

97 98 99 100 101
ReadOnlyArchiveInterface *Job::archiveInterface()
{
    return m_archiveInterface;
}

102 103 104 105 106
bool Job::isRunning() const
{
    return m_isRunning;
}

107 108
void Job::start()
{
109
    jobTimer.start();
110
    m_isRunning = true;
111

112
    if (archiveInterface()->waitForFinishedSignal()) {
113 114 115 116 117 118
        // 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();
    }
119 120
}

121 122 123 124 125 126
void Job::emitResult()
{
    m_isRunning = false;
    KJob::emitResult();
}

127 128
void Job::connectToArchiveInterfaceSignals()
{
Laurent Montel's avatar
Laurent Montel committed
129 130 131 132 133 134
    connect(archiveInterface(), &ReadOnlyArchiveInterface::cancelled, this, &Job::onCancelled);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::error, this, &Job::onError);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::entry, this, &Job::onEntry);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::entryRemoved, this, &Job::onEntryRemoved);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::progress, this, &Job::onProgress);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::info, this, &Job::onInfo);
135
    connect(archiveInterface(), &ReadOnlyArchiveInterface::finished, this, &Job::onFinished);
Laurent Montel's avatar
Laurent Montel committed
136
    connect(archiveInterface(), &ReadOnlyArchiveInterface::userQuery, this, &Job::onUserQuery);
137 138
}

139 140
void Job::onCancelled()
{
141
    qCDebug(ARK) << "Cancelled emitted";
142 143 144
    setError(KJob::KilledJobError);
}

145 146
void Job::onError(const QString & message, const QString & details)
{
147
    Q_UNUSED(details)
148

149
    qCDebug(ARK) << "Error emitted:" << message;
150
    setError(KJob::UserDefinedError);
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
    setErrorText(message);
}

void Job::onEntry(const ArchiveEntry & archiveEntry)
{
    emit newEntry(archiveEntry);
}

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)
{
176
    qCDebug(ARK) << "Job finished, result:" << result << ", time:" << jobTimer.elapsed() << "ms";
177 178 179 180 181 182 183 184 185 186 187

    emitResult();
}

void Job::onUserQuery(Query *query)
{
    emit userQuery(query);
}

bool Job::doKill()
{
188
    bool ret = archiveInterface()->doKill();
189
    if (!ret) {
190
        qCWarning(ARK) << "Killing does not seem to be supported here.";
191
    }
192 193 194
    return ret;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
195 196
ListJob::ListJob(ReadOnlyArchiveInterface *interface)
    : Job(interface)
197 198 199
    , m_isSingleFolderArchive(true)
    , m_isPasswordProtected(false)
    , m_extractedFilesSize(0)
200 201
    , m_dirCount(0)
    , m_filesCount(0)
202
{
203
    qCDebug(ARK) << "ListJob started";
Laurent Montel's avatar
Laurent Montel committed
204
    connect(this, &ListJob::newEntry, this, &ListJob::onNewEntry);
205 206 207 208 209
}

void ListJob::doWork()
{
    emit description(this, i18n("Loading archive..."));
210
    connectToArchiveInterfaceSignals();
211
    bool ret = archiveInterface()->list();
212

213
    if (!archiveInterface()->waitForFinishedSignal()) {
214
        onFinished(ret);
215
    }
216 217
}

218
qlonglong ListJob::extractedFilesSize() const
219 220 221 222
{
    return m_extractedFilesSize;
}

223
bool ListJob::isPasswordProtected() const
224 225 226 227
{
    return m_isPasswordProtected;
}

228
bool ListJob::isSingleFolderArchive() const
229
{
230 231 232 233
    if (m_filesCount == 1 && m_dirCount == 0) {
        return false;
    }

234 235 236
    return m_isSingleFolderArchive;
}

237 238 239 240 241
void ListJob::onNewEntry(const ArchiveEntry& entry)
{
    m_extractedFilesSize += entry[ Size ].toLongLong();
    m_isPasswordProtected |= entry [ IsPasswordProtected ].toBool();

242 243 244 245 246 247
    if (entry[IsDirectory].toBool()) {
        m_dirCount++;
    } else {
        m_filesCount++;
    }

248
    if (m_isSingleFolderArchive) {
249 250 251
        // RPM filenames have the ./ prefix, and "." would be detected as the subfolder name, so we remove it.
        const QString fileName = entry[FileName].toString().replace(QRegularExpression(QStringLiteral("^\\./")), QString());
        const QString basePath = fileName.split(QLatin1Char('/')).at(0);
252

253 254 255
        if (m_basePath.isEmpty()) {
            m_basePath = basePath;
            m_subfolderName = basePath;
256
        } else {
257 258 259 260
            if (m_basePath != basePath) {
                m_isSingleFolderArchive = false;
                m_subfolderName.clear();
            }
261 262 263 264
        }
    }
}

265
QString ListJob::subfolderName() const
266
{
267 268 269 270
    if (!isSingleFolderArchive()) {
        return QString();
    }

271 272 273
    return m_subfolderName;
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
274 275
ExtractJob::ExtractJob(const QVariantList& files, const QString& destinationDir, const ExtractionOptions& options, ReadOnlyArchiveInterface *interface)
    : Job(interface)
276 277 278
    , m_files(files)
    , m_destinationDir(destinationDir)
    , m_options(options)
279
{
280
    qCDebug(ARK) << "ExtractJob created";
281
    setDefaultOptions();
282 283 284 285 286 287 288 289 290 291 292 293
}

void ExtractJob::doWork()
{
    QString desc;
    if (m_files.count() == 0) {
        desc = i18n("Extracting all files");
    } else {
        desc = i18np("Extracting one file", "Extracting %1 files", m_files.count());
    }
    emit description(this, desc);

294 295 296 297 298 299 300
    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;
    }

301
    connectToArchiveInterfaceSignals();
302

303
    qCDebug(ARK) << "Starting extraction with" << m_files.count() << "selected files."
304 305
             << "Destination dir:" << m_destinationDir
             << "Options:" << m_options;
306

307
    bool ret = archiveInterface()->copyFiles(m_files, m_destinationDir, m_options);
308

309
    if (!archiveInterface()->waitForFinishedSignal()) {
310
        onFinished(ret);
311
    }
312 313
}

314
void ExtractJob::setDefaultOptions()
315
{
316 317
    ExtractionOptions defaultOptions;

318
    defaultOptions[QStringLiteral("PreservePaths")] = false;
319 320 321 322 323 324

    ExtractionOptions::const_iterator it = defaultOptions.constBegin();
    for (; it != defaultOptions.constEnd(); ++it) {
        if (!m_options.contains(it.key())) {
            m_options[it.key()] = it.value();
        }
325 326 327
    }
}

328 329 330 331 332
QString ExtractJob::destinationDirectory() const
{
    return m_destinationDir;
}

333 334 335 336 337
ExtractionOptions ExtractJob::extractionOptions() const
{
    return m_options;
}

338 339 340 341 342
TempExtractJob::TempExtractJob(const QString &file, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : Job(interface)
    , m_file(file)
    , m_passwordProtectedHint(passwordProtectedHint)
{
343
    m_tmpExtractDir = new QTemporaryDir();
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
}

QString TempExtractJob::validatedFilePath() const
{
    QString path = extractionDir() + QLatin1Char('/') + m_file;

    // 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;
    options[QStringLiteral("PreservePaths")] = true;

    if (m_passwordProtectedHint) {
        options[QStringLiteral("PasswordProtectedHint")] = true;
    }

    return options;
}

370 371 372 373 374
QTemporaryDir *TempExtractJob::tempDir() const
{
    return m_tmpExtractDir;
}

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
void TempExtractJob::doWork()
{
    emit description(this, i18n("Extracting one file"));

    connectToArchiveInterfaceSignals();

    qCDebug(ARK) << "Extracting:" << m_file;

    bool ret = archiveInterface()->copyFiles({ QVariant::fromValue(fileRootNodePair(m_file)) }, extractionDir(), extractionOptions());

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

390
QString TempExtractJob::extractionDir() const
391
{
392
    return m_tmpExtractDir->path();
393 394
}

395 396
PreviewJob::PreviewJob(const QString& file, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : TempExtractJob(file, passwordProtectedHint, interface)
397
{
398
    qCDebug(ARK) << "PreviewJob started";
399 400 401 402 403 404 405 406 407 408 409 410 411 412
}

OpenJob::OpenJob(const QString& file, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : TempExtractJob(file, passwordProtectedHint, interface)
{
    qCDebug(ARK) << "OpenJob started";
}

OpenWithJob::OpenWithJob(const QString& file, bool passwordProtectedHint, ReadOnlyArchiveInterface *interface)
    : OpenJob(file, passwordProtectedHint, interface)
{
    qCDebug(ARK) << "OpenWithJob started";
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
413 414
AddJob::AddJob(const QStringList& files, const CompressionOptions& options , ReadWriteArchiveInterface *interface)
    : Job(interface)
415 416
    , m_files(files)
    , m_options(options)
417
{
418
    qCDebug(ARK) << "AddJob started";
419 420 421 422
}

void AddJob::doWork()
{
Elvis Angelaccio's avatar
Elvis Angelaccio committed
423
    qCDebug(ARK) << "AddJob: going to add" << m_files.count() << "file(s)";
424

425 426 427
    emit description(this, i18np("Adding a file", "Adding %1 files", m_files.count()));

    ReadWriteArchiveInterface *m_writeInterface =
428
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
429 430 431

    Q_ASSERT(m_writeInterface);

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
    const QString globalWorkDir = m_options.value(QStringLiteral("GlobalWorkDir")).toString();
    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);
    }

    // The file paths must be relative to GlobalWorkDir.
    QStringList relativeFiles;
    foreach (const QString& file, m_files) {
        // #191821: workDir must be used instead of QDir::current()
        //          so that symlinks aren't resolved automatically
        QString relativePath = workDir.relativeFilePath(file);

        if (file.endsWith(QLatin1Char('/'))) {
            relativePath += QLatin1Char('/');
        }

        relativeFiles << relativePath;
    }

454
    connectToArchiveInterfaceSignals();
455
    bool ret = m_writeInterface->addFiles(relativeFiles, m_options);
456

457
    if (!archiveInterface()->waitForFinishedSignal()) {
458
        onFinished(ret);
459
    }
460 461
}

462 463 464 465 466 467 468 469 470
void AddJob::onFinished(bool result)
{
    if (!m_oldWorkingDir.isEmpty()) {
        QDir::setCurrent(m_oldWorkingDir);
    }

    Job::onFinished(result);
}

Elvis Angelaccio's avatar
Elvis Angelaccio committed
471 472
DeleteJob::DeleteJob(const QVariantList& files, ReadWriteArchiveInterface *interface)
    : Job(interface)
473
    , m_files(files)
474 475 476 477 478 479 480 481
{
}

void DeleteJob::doWork()
{
    emit description(this, i18np("Deleting a file from the archive", "Deleting %1 files", m_files.count()));

    ReadWriteArchiveInterface *m_writeInterface =
482
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
483 484 485

    Q_ASSERT(m_writeInterface);

486
    connectToArchiveInterfaceSignals();
487
    bool ret = m_writeInterface->deleteFiles(m_files);
488

489
    if (!archiveInterface()->waitForFinishedSignal()) {
490
        onFinished(ret);
491
    }
492
}
493

Elvis Angelaccio's avatar
Elvis Angelaccio committed
494 495
CommentJob::CommentJob(const QString& comment, ReadWriteArchiveInterface *interface)
    : Job(interface)
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
    , 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
517 518
TestJob::TestJob(ReadOnlyArchiveInterface *interface)
    : Job(interface)
Ragnar Thomsen's avatar
Ragnar Thomsen committed
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
{
    m_testSuccess = false;
}

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

    emit description(this, i18n("Testing archive"));
    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;
}

548
} // namespace Kerfuffle
549

550