jobs.cpp 7.44 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 <kubito@gmail.com>
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 <QApplication>
31
#include <QDir>
32
#include <QThread>
33 34 35

#include <KDebug>
#include <KLocale>
36

37 38
//#define DEBUG_RACECONDITION

39 40
namespace Kerfuffle
{
41

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

52 53
    virtual void run();

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 73
    : KJob(parent)
    , m_interface(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
bool Job::isRunning() const
{
    return m_isRunning;
}

100 101
void Job::start()
{
102
    m_isRunning = true;
103
    d->start();
104 105
}

106 107 108 109 110 111
void Job::emitResult()
{
    m_isRunning = false;
    KJob::emitResult();
}

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

    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)
{
142
    kDebug() << result;
143

144
    m_interface->removeObserver(this);
145 146 147 148 149 150 151 152 153 154 155

    emitResult();
}

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

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

ListJob::ListJob(ReadOnlyArchiveInterface *interface, QObject *parent)
165 166 167 168
    : Job(interface, parent)
    , m_isSingleFolderArchive(true)
    , m_isPasswordProtected(false)
    , m_extractedFilesSize(0)
169 170 171 172 173 174 175 176 177 178 179
{
    connect(this, SIGNAL(newEntry(const ArchiveEntry&)),
            this, SLOT(onNewEntry(const ArchiveEntry&)));
}

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

180 181 182
    if (!m_interface->waitForFinishedSignal()) {
        m_interface->finished(ret);
    }
183 184
}

185
qlonglong ListJob::extractedFilesSize() const
186 187 188 189
{
    return m_extractedFilesSize;
}

190
bool ListJob::isPasswordProtected() const
191 192 193 194
{
    return m_isPasswordProtected;
}

195
bool ListJob::isSingleFolderArchive() const
196 197 198 199
{
    return m_isSingleFolderArchive;
}

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

205 206
    if (m_isSingleFolderArchive) {
        const QString fileName(entry[FileName].toString());
207
        const QString basePath(fileName.split(QLatin1Char( '/' )).at(0));
208

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

221
QString ListJob::subfolderName() const
222 223 224 225
{
    return m_subfolderName;
}

226
ExtractJob::ExtractJob(const QVariantList& files, const QString& destinationDir, ExtractionOptions options, ReadOnlyArchiveInterface *interface, QObject *parent)
227 228 229 230
    : Job(interface, parent)
    , m_files(files)
    , m_destinationDir(destinationDir)
    , m_options(options)
231 232 233 234 235 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);

    m_interface->registerObserver(this);

    fillInDefaultValues(m_options);

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

    bool ret = m_interface->copyFiles(m_files, m_destinationDir, m_options);

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

void ExtractJob::fillInDefaultValues(ExtractionOptions& options)
{
262 263
    if (!options.contains(QLatin1String( "PreservePaths" ))) {
        options[QLatin1String( "PreservePaths" )] = false;
264 265 266 267
    }
}

AddJob::AddJob(const QStringList& files, const CompressionOptions& options , ReadWriteArchiveInterface *interface, QObject *parent)
268 269 270
    : Job(interface, parent)
    , m_files(files)
    , m_options(options)
271 272 273 274 275 276 277 278
{
}

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

    ReadWriteArchiveInterface *m_writeInterface =
279
        qobject_cast<ReadWriteArchiveInterface*>(m_interface);
280 281 282 283 284 285

    Q_ASSERT(m_writeInterface);

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

286 287 288
    if (!m_interface->waitForFinishedSignal()) {
        m_interface->finished(ret);
    }
289 290
}

291
DeleteJob::DeleteJob(const QVariantList& files, ReadWriteArchiveInterface *interface, QObject *parent)
292 293
    : Job(interface, parent)
    , m_files(files)
294 295 296 297 298 299 300 301
{
}

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

    ReadWriteArchiveInterface *m_writeInterface =
302
        qobject_cast<ReadWriteArchiveInterface*>(m_interface);
303 304 305 306 307 308

    Q_ASSERT(m_writeInterface);

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

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

314
} // namespace Kerfuffle
315 316

#include "jobs.moc"