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 "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 WADSEEKER_API Wadseeker : public QObject
{
        Q_OBJECT

        public:
                static const QString defaultSites[];

                static const QString forbiddenWads[];

                static const QString defaultIdgamesUrl();

                static QStringList defaultSitesListEncoded();

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

                static bool isForbiddenWad(const QString& wad);

                Wadseeker();

                ~Wadseeker();

                bool isDownloadingFile(const QString& file) const;

                bool isWorking() const;

                void setCustomSite(const QUrl& url);

                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 skipSiteSeek(const QUrl& url);

                bool startSeek(const QStringList& wads);

                QString targetDirectory() const;

        public slots:
                void abort();

        signals:
                void allDone(bool bSuccess);

                void fileDownloadFinished(const QString& filename);

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

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

                void fileInstalled(const QString& filename);

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

                void seekStarted(const QStringList& filenames);

                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:
                class SeekParameters
                {
                        public:
                                bool bIdgamesEnabled;
                                bool bWadArchiveEnabled;
                                QUrl customSiteUrl;
                                QString idgamesUrl;
                                unsigned maxConcurrentDownloads;
                                unsigned maxConcurrentSeeks;
                                QString saveDirectoryPath;
                                QStringList seekedWads;
                                QStringList sitesUrls;

                                SeekParameters();
                };

                class PrivData
                {
                        public:
                                bool bIsAborting;

                                QList<Idgames* > idgamesClients;

                                SeekParameters seekParameters;

                                SeekParameters* seekParametersForCurrentSeek;

                                WadArchiveClient* wadArchiveClient;
                                WadRetriever* wadRetriever;
                                WWWSeeker* wwwSeeker;
                };

                PrivData d;

                void cleanUpAfterFinish();
                bool isAllFinished() const;

                void prepareSeekObjects();

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

                void startNextIdgamesClient();
                void startWadArchiveClient();

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