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 <QObject>
#include <QString>
#include <QStringList>
#include <QUrl>

#include "dptr.h"
#include "entities/waddownloadinfo.h"
#include "wadseekerexportinfo.h"
#include "wadseekermessagetype.h"

#define WADSEEKER_CONNECT_TIMEOUT_SECONDS_DEFAULT 30
#define WADSEEKER_DOWNLOAD_TIMEOUT_SECONDS_DEFAULT 120

class Idgames;
class WadArchiveClient;
class WadRetriever;
class WWWSeeker;
class ModSet;
class ModFile;

class WADSEEKER_API Wadseeker : public QObject
{
        Q_OBJECT

public:
        static const QString defaultSites[];

        static const QString forbiddenWads[];

        static const QString defaultIdgamesUrl();

        static QStringList defaultSitesListEncoded();

        static ModSet filterAllowedOnlyWads(const ModSet &wads);
        static ModSet filterForbiddenOnlyWads(const ModSet &wads);

        static bool isForbiddenWad(const ModFile &wad);

        Wadseeker();

        ~Wadseeker() override;

        bool isDownloadingFile(const ModFile &file) const;

        bool isWorking() const;

        void setCustomSite(const QString &url);

        void setCustomSites(const QStringList &urls);

        void setIdgamesEnabled(bool bEnabled);

        void setIdgamesUrl(QString archiveURL);

        void setMaximumConcurrentDownloads(unsigned max);

        void setMaximumConcurrentSeeks(unsigned max);

        void setPrimarySites(const QStringList &urlList);

        void setPrimarySitesToDefault();

        void setTargetDirectory(const QString &dir);

        void setWadArchiveEnabled(bool enabled);

        void skipFileCurrentUrl(const QString &fileName);

        void skipService(const QString &service);

        void skipSiteSeek(const QUrl &url);

        bool startSeek(const ModSet &wads);

        QString targetDirectory() const;

public slots:
        void abort();

signals:
        void allDone(bool bSuccess);

        void fileDownloadFinished(const ModFile &filename);

        void fileDownloadProgress(const ModFile &filename, qint64 done, qint64 total);

        void fileDownloadStarted(const ModFile &filename, const QUrl &url);

        void fileInstalled(const ModFile &filename);

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

        void seekStarted(const ModSet &filenames);

        void serviceStarted(const QString &name);

        void serviceFinished(const QString &name);

        void siteFinished(const QUrl &site);

        void siteProgress(const QUrl &site, qint64 bytes, qint64 total);

        void siteRedirect(const QUrl &oldUrl, const QUrl &newUrl);

        void siteStarted(const QUrl &site);

private:
        DPtr<Wadseeker> d;

        void abortSeekers();
        void abortWwwSeeker();
        void cleanUpAfterFinish();
        bool isAllFinished() const;

        void prepareSeekObjects();

        void setupIdgamesClients(const QList<WadDownloadInfo> &wadDownloadInfoList);
        void setupSitesUrls();
        void setupWadArchiveClient(const QList<WadDownloadInfo> &wadDownloadInfos);

        void startNextIdgamesClient();
        void startIdgames();
        void stopIdgames();
        void startWadArchiveClient();
        void stopWadArchiveClient();

private slots:
        void cleanUpIfAllFinished();
        void fileLinkFound(const QString &filename, const QUrl &url);
        void fileMirrorLinksFound(const QString &filename, const QList<QUrl> &urls);
        void idgamesClientFinished(Idgames *pEmitter);
        void reportBadUrl(const QUrl &url);
        void wadArchiveFinished();
        void wadRetrieverDownloadFinished(WadDownloadInfo wadDownloadInfo);
        void wadRetrieverDownloadProgress(WadDownloadInfo wadDownloadInfo, qint64 current, qint64 total);
        void wadRetrieverDownloadStarted(WadDownloadInfo wadDownloadInfo, const QUrl &url);
        void wadRetrieverFinished();
        void wadRetrieverMessage(const QString &message, WadseekerLib::MessageType type);
        void wadRetrieverWadInstalled(WadDownloadInfo wadDownloadInfo);
        void wwwSeekerFinished();
};

#endif