jobs.cpp 9.89 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

35
#include <KLocalizedString>
36

37 38
//#define DEBUG_RACECONDITION

39 40
namespace Kerfuffle
{
41

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

52
    virtual void run() Q_DECL_OVERRIDE;
53

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

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

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

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

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

    setCapabilities(KJob::Killable);
}

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

92
    delete d;
93
}
94

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

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

105 106
void Job::start()
{
107
    jobTimer.start();
108
    m_isRunning = true;
109
    d->start();
110 111
}

112 113 114 115 116 117
void Job::emitResult()
{
    m_isRunning = false;
    KJob::emitResult();
}

118 119
void Job::connectToArchiveInterfaceSignals()
{
Laurent Montel's avatar
Laurent Montel committed
120 121 122 123 124 125 126 127
    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);
128 129
}

130 131
void Job::onCancelled()
{
132
    qCDebug(ARK) << "Cancelled emitted";
133 134 135
    setError(KJob::KilledJobError);
}

136 137
void Job::onError(const QString & message, const QString & details)
{
138
    Q_UNUSED(details)
139

140
    qCDebug(ARK) << "Error emitted:" << message;
141
    setError(KJob::UserDefinedError);
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
    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)
{
167
    qCDebug(ARK) << "Job finished, result:" << result << ", time:" << jobTimer.elapsed() << "ms";
168

169
    archiveInterface()->disconnect(this);
170 171 172 173 174 175 176 177 178 179 180

    emitResult();
}

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

bool Job::doKill()
{
181
    bool ret = archiveInterface()->doKill();
182
    if (!ret) {
183
        qCWarning(ARK) << "Killing does not seem to be supported here.";
184
    }
185 186 187 188
    return ret;
}

ListJob::ListJob(ReadOnlyArchiveInterface *interface, QObject *parent)
189 190 191 192
    : Job(interface, parent)
    , m_isSingleFolderArchive(true)
    , m_isPasswordProtected(false)
    , m_extractedFilesSize(0)
193 194
    , m_dirCount(0)
    , m_filesCount(0)
195
{
196
    qCDebug(ARK) << "ListJob started";
Laurent Montel's avatar
Laurent Montel committed
197
    connect(this, &ListJob::newEntry, this, &ListJob::onNewEntry);
198 199 200 201 202
}

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

206
    if (!archiveInterface()->waitForFinishedSignal()) {
207
        onFinished(ret);
208
    }
209 210
}

211
qlonglong ListJob::extractedFilesSize() const
212 213 214 215
{
    return m_extractedFilesSize;
}

216
bool ListJob::isPasswordProtected() const
217 218 219 220
{
    return m_isPasswordProtected;
}

221
bool ListJob::isSingleFolderArchive() const
222
{
223 224 225 226
    if (m_filesCount == 1 && m_dirCount == 0) {
        return false;
    }

227 228 229
    return m_isSingleFolderArchive;
}

230 231 232 233 234
void ListJob::onNewEntry(const ArchiveEntry& entry)
{
    m_extractedFilesSize += entry[ Size ].toLongLong();
    m_isPasswordProtected |= entry [ IsPasswordProtected ].toBool();

235 236 237 238 239 240
    if (entry[IsDirectory].toBool()) {
        m_dirCount++;
    } else {
        m_filesCount++;
    }

241
    if (m_isSingleFolderArchive) {
242 243 244
        // 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);
245

246 247 248
        if (m_basePath.isEmpty()) {
            m_basePath = basePath;
            m_subfolderName = basePath;
249
        } else {
250 251 252 253
            if (m_basePath != basePath) {
                m_isSingleFolderArchive = false;
                m_subfolderName.clear();
            }
254 255 256 257
        }
    }
}

258
QString ListJob::subfolderName() const
259
{
260 261 262 263
    if (!isSingleFolderArchive()) {
        return QString();
    }

264 265 266
    return m_subfolderName;
}

267
ExtractJob::ExtractJob(const QVariantList& files, const QString& destinationDir, const ExtractionOptions& options, ReadOnlyArchiveInterface *interface, QObject *parent)
268 269 270 271
    : Job(interface, parent)
    , m_files(files)
    , m_destinationDir(destinationDir)
    , m_options(options)
272
{
273
    qCDebug(ARK) << "ExtractJob created";
274
    setDefaultOptions();
275 276 277 278 279 280 281 282 283 284 285 286
}

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

287 288 289 290 291 292 293
    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;
    }

294
    connectToArchiveInterfaceSignals();
295

296
    qCDebug(ARK) << "Starting extraction with selected files:"
297 298 299
             << m_files
             << "Destination dir:" << m_destinationDir
             << "Options:" << m_options;
300

301
    bool ret = archiveInterface()->copyFiles(m_files, m_destinationDir, m_options);
302

303
    if (!archiveInterface()->waitForFinishedSignal()) {
304
        onFinished(ret);
305
    }
306 307
}

308
void ExtractJob::setDefaultOptions()
309
{
310 311
    ExtractionOptions defaultOptions;

312
    defaultOptions[QStringLiteral("PreservePaths")] = false;
313 314 315 316 317 318

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

322 323 324 325 326
QString ExtractJob::destinationDirectory() const
{
    return m_destinationDir;
}

327 328 329 330 331
ExtractionOptions ExtractJob::extractionOptions() const
{
    return m_options;
}

332
AddJob::AddJob(const QStringList& files, const CompressionOptions& options , ReadWriteArchiveInterface *interface, QObject *parent)
333 334 335
    : Job(interface, parent)
    , m_files(files)
    , m_options(options)
336
{
337
    qCDebug(ARK) << "AddJob started";
338 339 340 341
}

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

344 345 346
    emit description(this, i18np("Adding a file", "Adding %1 files", m_files.count()));

    ReadWriteArchiveInterface *m_writeInterface =
347
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
348 349 350

    Q_ASSERT(m_writeInterface);

351
    connectToArchiveInterfaceSignals();
352 353
    bool ret = m_writeInterface->addFiles(m_files, m_options);

354
    if (!archiveInterface()->waitForFinishedSignal()) {
355
        onFinished(ret);
356
    }
357 358
}

359
DeleteJob::DeleteJob(const QVariantList& files, ReadWriteArchiveInterface *interface, QObject *parent)
360 361
    : Job(interface, parent)
    , m_files(files)
362 363 364 365 366 367 368 369
{
}

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

    ReadWriteArchiveInterface *m_writeInterface =
370
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
371 372 373

    Q_ASSERT(m_writeInterface);

374
    connectToArchiveInterfaceSignals();
375
    bool ret = m_writeInterface->deleteFiles(m_files);
376

377
    if (!archiveInterface()->waitForFinishedSignal()) {
378
        onFinished(ret);
379
    }
380
}
381

382
} // namespace Kerfuffle
383

384