jobs.cpp 10.1 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 <QFileInfo>
32
#include <QRegularExpression>
33
#include <QThread>
34
#include <QTimer>
35

36
#include <KLocalizedString>
37

38 39
//#define DEBUG_RACECONDITION

40 41
namespace Kerfuffle
{
42

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

53
    virtual void run() Q_DECL_OVERRIDE;
54

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

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

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

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

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

    setCapabilities(KJob::Killable);
}

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

93
    delete d;
94
}
95

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

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

106 107
void Job::start()
{
108
    jobTimer.start();
109
    m_isRunning = true;
110 111 112 113 114 115 116 117

    if (archiveInterface()->isCliBased()) {
        // 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();
    }
118 119
}

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

126 127
void Job::connectToArchiveInterfaceSignals()
{
Laurent Montel's avatar
Laurent Montel committed
128 129 130 131 132 133 134 135
    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);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::finished, this, &Job::onFinished, Qt::DirectConnection);
    connect(archiveInterface(), &ReadOnlyArchiveInterface::userQuery, this, &Job::onUserQuery);
136 137
}

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

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

148
    qCDebug(ARK) << "Error emitted:" << message;
149
    setError(KJob::UserDefinedError);
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
    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)
{
175
    qCDebug(ARK) << "Job finished, result:" << result << ", time:" << jobTimer.elapsed() << "ms";
176

177
    archiveInterface()->disconnect(this);
178 179 180 181 182 183 184 185 186 187 188

    emitResult();
}

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

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

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

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

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

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

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

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

235 236 237
    return m_isSingleFolderArchive;
}

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

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

249
    if (m_isSingleFolderArchive) {
250 251 252
        // 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);
253

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

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

272 273 274
    return m_subfolderName;
}

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

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

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

302
    connectToArchiveInterfaceSignals();
303

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

309
    bool ret = archiveInterface()->copyFiles(m_files, m_destinationDir, m_options);
310

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

316
void ExtractJob::setDefaultOptions()
317
{
318 319
    ExtractionOptions defaultOptions;

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

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

330 331 332 333 334
QString ExtractJob::destinationDirectory() const
{
    return m_destinationDir;
}

335 336 337 338 339
ExtractionOptions ExtractJob::extractionOptions() const
{
    return m_options;
}

340
AddJob::AddJob(const QStringList& files, const CompressionOptions& options , ReadWriteArchiveInterface *interface, QObject *parent)
341 342 343
    : Job(interface, parent)
    , m_files(files)
    , m_options(options)
344
{
345
    qCDebug(ARK) << "AddJob started";
346 347 348 349
}

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

352 353 354
    emit description(this, i18np("Adding a file", "Adding %1 files", m_files.count()));

    ReadWriteArchiveInterface *m_writeInterface =
355
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
356 357 358

    Q_ASSERT(m_writeInterface);

359
    connectToArchiveInterfaceSignals();
360 361
    bool ret = m_writeInterface->addFiles(m_files, m_options);

362
    if (!archiveInterface()->waitForFinishedSignal()) {
363
        onFinished(ret);
364
    }
365 366
}

367
DeleteJob::DeleteJob(const QVariantList& files, ReadWriteArchiveInterface *interface, QObject *parent)
368 369
    : Job(interface, parent)
    , m_files(files)
370 371 372 373 374 375 376 377
{
}

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

    ReadWriteArchiveInterface *m_writeInterface =
378
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
379 380 381

    Q_ASSERT(m_writeInterface);

382
    connectToArchiveInterfaceSignals();
383
    bool ret = m_writeInterface->deleteFiles(m_files);
384

385
    if (!archiveInterface()->waitForFinishedSignal()) {
386
        onFinished(ret);
387
    }
388
}
389

390
} // namespace Kerfuffle
391

392