jobs.cpp 7.91 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-2010 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 29
#include "jobs.h"

30
#include <QThread>
31 32 33

#include <KDebug>
#include <KLocale>
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 51
    virtual void run();

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
    m_isRunning = true;
106
    d->start();
107 108
}

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

115 116
void Job::onError(const QString & message, const QString & details)
{
117
    Q_UNUSED(details)
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144

    setError(1);
    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)
{
145
    kDebug() << result;
146

147
    archiveInterface()->removeObserver(this);
148 149 150 151 152 153 154 155 156 157 158

    emitResult();
}

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

bool Job::doKill()
{
159
    kDebug();
160
    bool ret = archiveInterface()->doKill();
161
    if (!ret) {
162
        kDebug() << "Killing does not seem to be supported here.";
163
    }
164 165 166 167
    return ret;
}

ListJob::ListJob(ReadOnlyArchiveInterface *interface, QObject *parent)
168 169 170 171
    : Job(interface, parent)
    , m_isSingleFolderArchive(true)
    , m_isPasswordProtected(false)
    , m_extractedFilesSize(0)
172
{
Laurent Montel's avatar
Laurent Montel committed
173 174
    connect(this, SIGNAL(newEntry(ArchiveEntry)),
            this, SLOT(onNewEntry(ArchiveEntry)));
175 176 177 178 179
}

void ListJob::doWork()
{
    emit description(this, i18n("Loading archive..."));
180 181
    archiveInterface()->registerObserver(this);
    bool ret = archiveInterface()->list();
182

183 184
    if (!archiveInterface()->waitForFinishedSignal()) {
        archiveInterface()->finished(ret);
185
    }
186 187
}

188
qlonglong ListJob::extractedFilesSize() const
189 190 191 192
{
    return m_extractedFilesSize;
}

193
bool ListJob::isPasswordProtected() const
194 195 196 197
{
    return m_isPasswordProtected;
}

198
bool ListJob::isSingleFolderArchive() const
199 200 201 202
{
    return m_isSingleFolderArchive;
}

203 204 205 206 207
void ListJob::onNewEntry(const ArchiveEntry& entry)
{
    m_extractedFilesSize += entry[ Size ].toLongLong();
    m_isPasswordProtected |= entry [ IsPasswordProtected ].toBool();

208 209
    if (m_isSingleFolderArchive) {
        const QString fileName(entry[FileName].toString());
210
        const QString basePath(fileName.split(QLatin1Char( '/' )).at(0));
211

212 213 214
        if (m_basePath.isEmpty()) {
            m_basePath = basePath;
            m_subfolderName = basePath;
215
        } else {
216 217 218 219
            if (m_basePath != basePath) {
                m_isSingleFolderArchive = false;
                m_subfolderName.clear();
            }
220 221 222 223
        }
    }
}

224
QString ListJob::subfolderName() const
225 226 227 228
{
    return m_subfolderName;
}

229
ExtractJob::ExtractJob(const QVariantList& files, const QString& destinationDir, ExtractionOptions options, ReadOnlyArchiveInterface *interface, QObject *parent)
230 231 232 233
    : Job(interface, parent)
    , m_files(files)
    , m_destinationDir(destinationDir)
    , m_options(options)
234
{
235
    setDefaultOptions();
236 237 238 239 240 241 242 243 244 245 246 247
}

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

248
    archiveInterface()->registerObserver(this);
249

250 251 252 253
    kDebug() << "Starting extraction with selected files:"
             << m_files
             << "Destination dir:" << m_destinationDir
             << "Options:" << m_options;
254

255
    bool ret = archiveInterface()->copyFiles(m_files, m_destinationDir, m_options);
256

257 258
    if (!archiveInterface()->waitForFinishedSignal()) {
        archiveInterface()->finished(ret);
259
    }
260 261
}

262
void ExtractJob::setDefaultOptions()
263
{
264 265 266 267 268 269 270 271 272
    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();
        }
273 274 275
    }
}

276 277 278 279 280
QString ExtractJob::destinationDirectory() const
{
    return m_destinationDir;
}

281 282 283 284 285
ExtractionOptions ExtractJob::extractionOptions() const
{
    return m_options;
}

286
AddJob::AddJob(const QStringList& files, const CompressionOptions& options , ReadWriteArchiveInterface *interface, QObject *parent)
287 288 289
    : Job(interface, parent)
    , m_files(files)
    , m_options(options)
290 291 292 293 294 295 296 297
{
}

void AddJob::doWork()
{
    emit description(this, i18np("Adding a file", "Adding %1 files", m_files.count()));

    ReadWriteArchiveInterface *m_writeInterface =
298
        qobject_cast<ReadWriteArchiveInterface*>(archiveInterface());
299 300 301 302 303 304

    Q_ASSERT(m_writeInterface);

    m_writeInterface->registerObserver(this);
    bool ret = m_writeInterface->addFiles(m_files, m_options);

305 306
    if (!archiveInterface()->waitForFinishedSignal()) {
        archiveInterface()->finished(ret);
307
    }
308 309
}

310
DeleteJob::DeleteJob(const QVariantList& files, ReadWriteArchiveInterface *interface, QObject *parent)
311 312
    : Job(interface, parent)
    , m_files(files)
313 314 315 316 317 318 319 320
{
}

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

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

    Q_ASSERT(m_writeInterface);

    m_writeInterface->registerObserver(this);
    int ret = m_writeInterface->deleteFiles(m_files);

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

333
} // namespace Kerfuffle
334 335

#include "jobs.moc"