src/wadseeker/wadseeker.h

//------------------------------------------------------------------------------
// wadseeker.h
//------------------------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301  USA
//
//------------------------------------------------------------------------------
// Copyright (C) 2009 "Zalewa" <zalewapl@gmail.com>
//------------------------------------------------------------------------------
#ifndef __WADSEEKER_H_
#define __WADSEEKER_H_

#include <QList>
#include <QString>
#include <QStringList>
#include <QUrl>

#include "wadseekerexportinfo.h"

#define WADSEEKER_CONNECT_TIMEOUT_SECONDS_DEFAULT 30
#define WADSEEKER_DOWNLOAD_TIMEOUT_SECONDS_DEFAULT 120

class SpeedCalculator;
class WWWSeeker;

class WADSEEKER_API Wadseeker : public QObject
{
    Q_OBJECT

    public:
        enum MessageType
        {
            Notice          = 0,
            NoticeImportant = 1,
            Error           = 2,
            CriticalError   = 3
        };

        static const QString    defaultSites[];
        static const QString    forbiddenWads[];

        static const QString    defaultIdgamesUrl();

        static QStringList      defaultSitesListEncoded();

        static bool             isForbiddenWad(const QString& wad);

        static void             setTimeConnectTimeout(int seconds);

        static void             setTimeDownloadTimeout(int seconds);

        Wadseeker();
        ~Wadseeker();

        bool                areAllFilesFound() const;
        
        float               downloadSpeed() const;
        
        float               estimatedTimeUntilArrivalOfCurrentFile() const;

        const QStringList&  filesNotFound() const;

        void                seekWads(const QStringList& wads);

        void                setCustomSite(const QUrl& url);

        void                setPrimarySites(const QStringList& lst);

        void                setPrimarySitesToDefault();

        void                setTargetDirectory(const QString& dir);

        void                setUseIdgames(bool use, bool highPriority = false, QString archiveURL = defaultIdgamesUrl());

        QString             targetDirectory() const;

    public slots:
        void                abort();

        void                skipSite();

    signals:
        void aborted();

        void allDone();

        void downloadProgress(int done, int total);

        void message(const QString& msg, Wadseeker::MessageType type);

    protected:
        static QStringList  wantedFilenames(const QString& wad, QString& zip);

    protected slots:
        void            messageSlot(const QString& msg, int type);

        void            wwwAborted();

    private:
        int                 iNextWad;
        QString             currentWad;
        QStringList         notFound;
        QStringList         seekedWads;
        SpeedCalculator*    speedCalculator;
        QString             targetDir;
        
        WWWSeeker*          www;

        void    nextWad();

    // The following slots are used to pickup progress from the WWW object.
    private slots:
        void            downloadProgressSlot(int done, int total);
        void            fileDone(QByteArray& data, const QString& filename);
        void            wadFail();
};

#endif