jobs.cpp 8.95 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 <QThread>
32

33
#include <KLocalizedString>
34

35 36
//#define DEBUG_RACECONDITION

37 38
namespace Kerfuffle
{
39

40 41 42
class Job::Private : public QThread
{
public:
43 44 45 46 47 48 49
    Private(Job *job, QObject *parent = 0)
        : QThread(parent)
        , q(job)
    {
        connect(q, SIGNAL(result(KJob*)), SLOT(quit()));
    }

50
    virtual void run() Q_DECL_OVERRIDE;
51

52
private:
53 54 55 56 57
    Job *q;
};

void Job::Private::run()
{
58
    q->doWork();
59

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

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

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

    setCapabilities(KJob::Killable);
}

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

90
    delete d;
91
}
92

93 94 95 96 97
ReadOnlyArchiveInterface *Job::archiveInterface()
{
    return m_archiveInterface;
}

98 99 100 101 102
bool Job::isRunning() const
{
    return m_isRunning;
}

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

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

116 117
void Job::connectToArchiveInterfaceSignals()
{
118
    connect(archiveInterface(), SIGNAL(cancelled()), SLOT(onCancelled()));
119 120 121 122 123
    connect(archiveInterface(), SIGNAL(error(QString,QString)), SLOT(onError(QString,QString)));
    connect(archiveInterface(), SIGNAL(entry(ArchiveEntry)), SLOT(onEntry(ArchiveEntry)));
    connect(archiveInterface(), SIGNAL(entryRemoved(QString)), SLOT(onEntryRemoved(QString)));
    connect(archiveInterface(), SIGNAL(progress(double)), SLOT(onProgress(double)));
    connect(archiveInterface(), SIGNAL(info(QString)), SLOT(onInfo(QString)));
124
    connect(archiveInterface(), SIGNAL(finished(bool)), SLOT(onFinished(bool)), Qt::DirectConnection);
125 126 127
    connect(archiveInterface(), SIGNAL(userQuery(Query*)), SLOT(onUserQuery(Query*)));
}

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

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

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

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

    emitResult();
}

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

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

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

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

202
    if (!archiveInterface()->waitForFinishedSignal()) {
203
        onFinished(ret);
204
    }
205 206
}

207
qlonglong ListJob::extractedFilesSize() const
208 209 210 211
{
    return m_extractedFilesSize;
}

212
bool ListJob::isPasswordProtected() const
213 214 215 216
{
    return m_isPasswordProtected;
}

217
bool ListJob::isSingleFolderArchive() const
218 219 220 221
{
    return m_isSingleFolderArchive;
}

222 223 224 225 226
void ListJob::onNewEntry(const ArchiveEntry& entry)
{
    m_extractedFilesSize += entry[ Size ].toLongLong();
    m_isPasswordProtected |= entry [ IsPasswordProtected ].toBool();

227 228
    if (m_isSingleFolderArchive) {
        const QString fileName(entry[FileName].toString());
229
        const QString basePath(fileName.split(QLatin1Char( '/' )).at(0));
230

231 232 233
        if (m_basePath.isEmpty()) {
            m_basePath = basePath;
            m_subfolderName = basePath;
234
        } else {
235 236 237 238
            if (m_basePath != basePath) {
                m_isSingleFolderArchive = false;
                m_subfolderName.clear();
            }
239 240 241 242
        }
    }
}

243
QString ListJob::subfolderName() const
244 245 246 247
{
    return m_subfolderName;
}

248
ExtractJob::ExtractJob(const QVariantList& files, const QString& destinationDir, ExtractionOptions options, ReadOnlyArchiveInterface *interface, QObject *parent)
249 250 251 252
    : Job(interface, parent)
    , m_files(files)
    , m_destinationDir(destinationDir)
    , m_options(options)
253
{
254
    qCDebug(ARK) << "ExtractJob created";
255
    setDefaultOptions();
256 257 258 259 260 261 262 263 264 265 266 267
}

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

268
    connectToArchiveInterfaceSignals();
269

270
    qCDebug(ARK) << "Starting extraction with selected files:"
271 272 273
             << m_files
             << "Destination dir:" << m_destinationDir
             << "Options:" << m_options;
274

275
    bool ret = archiveInterface()->copyFiles(m_files, m_destinationDir, m_options);
276

277
    if (!archiveInterface()->waitForFinishedSignal()) {
278
        onFinished(ret);
279
    }
280 281
}

282
void ExtractJob::setDefaultOptions()
283
{
284 285 286 287 288 289 290 291 292
    ExtractionOptions defaultOptions;

    defaultOptions[QLatin1String("PreservePaths")] = false;

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

296 297 298 299 300
QString ExtractJob::destinationDirectory() const
{
    return m_destinationDir;
}

301 302 303 304 305
ExtractionOptions ExtractJob::extractionOptions() const
{
    return m_options;
}

306
AddJob::AddJob(const QStringList& files, const CompressionOptions& options , ReadWriteArchiveInterface *interface, QObject *parent)
307 308 309
    : Job(interface, parent)
    , m_files(files)
    , m_options(options)
310
{
311
    qCDebug(ARK) << "AddJob started";
312 313 314 315
}

void AddJob::doWork()
{
316
    qCDebug(ARK) << "AddJob doing work";
317

318 319 320
    emit description(this, i18np("Adding a file", "Adding %1 files", m_files.count()));

    ReadWriteArchiveInterface *m_writeInterface =
321
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
322 323 324

    Q_ASSERT(m_writeInterface);

325
    connectToArchiveInterfaceSignals();
326 327
    bool ret = m_writeInterface->addFiles(m_files, m_options);

328
    if (!archiveInterface()->waitForFinishedSignal()) {
329
        onFinished(ret);
330
    }
331 332
}

333
DeleteJob::DeleteJob(const QVariantList& files, ReadWriteArchiveInterface *interface, QObject *parent)
334 335
    : Job(interface, parent)
    , m_files(files)
336 337 338 339 340 341 342 343
{
}

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

    ReadWriteArchiveInterface *m_writeInterface =
344
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
345 346 347

    Q_ASSERT(m_writeInterface);

348
    connectToArchiveInterfaceSignals();
349
    bool ret = m_writeInterface->deleteFiles(m_files);
350

351
    if (!archiveInterface()->waitForFinishedSignal()) {
352
        onFinished(ret);
353
    }
354
}
355

356
} // namespace Kerfuffle
357

358