wadseekerinterface.cpp

//------------------------------------------------------------------------------
// wadseekerinterface.cpp
//------------------------------------------------------------------------------
//
// 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>
//------------------------------------------------------------------------------
#include "gui/wadseekerinterface.h"
#include "ui_wadseekerinterface.h"

#include "configuration/doomseekerconfig.h"
#include "gui/helpers/taskbarbutton.h"
#include "gui/helpers/taskbarprogress.h"
#include "serverapi/server.h"
#include "application.h"
#include "mainwindow.h"
#include "strings.hpp"

#include <QMessageBox>

const int WadseekerInterface::UPDATE_INTERVAL_MS = 500;
WadseekerInterface *WadseekerInterface::currentInstance = NULL;

DClass<WadseekerInterface> : public Ui::WadseekerInterface
{
public:
        bool bCompletedSuccessfully;
        bool preventGame;
        TaskbarButton *taskbarButton;
        TaskbarProgress *taskbarProgress;
};

DPointered(WadseekerInterface)

WadseekerInterface::WadseekerInterface(QWidget* parent)
: QDialog(parent)
{
        construct();
        bAutomatic = false;
}

WadseekerInterface::WadseekerInterface(ServerPtr server, QWidget* parent)
: QDialog(parent)
{
        construct();
        setupAutomatic();
        d->lblTop->show();
        d->lblTop->setText(tr("Downloading WADs for server \"%1\"").arg(server->name()));
        setCustomSite(server->webSite());
}

WadseekerInterface::~WadseekerInterface()
{
        currentInstance = NULL;
}

void WadseekerInterface::abortService(const QString &service)
{
        message(tr("Aborting service: %1").arg(service), WadseekerLib::Notice);
        wadseeker.skipService(service);
}

void WadseekerInterface::abortSite(const QUrl &url)
{
        message(tr("Aborting site: %1").arg(url.toString()), WadseekerLib::Notice);
        wadseeker.skipSiteSeek(url);
}

void WadseekerInterface::accept()
{
        if (isAutomatic())
        {
                if (d->bCompletedSuccessfully)
                {
                        done(QDialog::Accepted);
                }
        }
        else
        {
                if (d->leWadName->text().isEmpty())
                {
                        return;
                }

                startSeeking(d->leWadName->text().split(',', QString::SkipEmptyParts));
        }
}

void WadseekerInterface::allDone(bool bSuccess)
{
        setStateWaiting();
        d->bCompletedSuccessfully = bSuccess;
        QApplication::alert(this);
        if (bSuccess)
        {
                displayMessage(tr("All done. Success."), WadseekerLib::NoticeImportant, false);

                if (isAutomatic() && !d->preventGame)
                {
                        if (isActiveWindow())
                        {
                                done(QDialog::Accepted);
                        }
                        else
                        {
                                d->btnStartGame->show();
                        }
                }
        }
        else
        {
                QStringList failures = unsuccessfulWads();

                foreach (const QString& failure, failures)
                {
                        d->twWads->setFileFailed(failure);
                }

                displayMessage(tr("All done. Fail."), WadseekerLib::CriticalError, false);
        }
}

void WadseekerInterface::connectWadseekerObject()
{
        // Connect Wadseeker to the dialog box.
        this->connect(&wadseeker, SIGNAL( allDone(bool) ),
                SLOT( allDone(bool) ) );
        this->connect(&wadseeker, SIGNAL( message(const QString&, WadseekerLib::MessageType) ),
                SLOT( message(const QString&, WadseekerLib::MessageType) ) );
        this->connect(&wadseeker, SIGNAL( seekStarted(const QStringList&) ),
                SLOT( seekStarted(const QStringList&) ) );
        this->connect(&wadseeker, SIGNAL( fileInstalled(const QString&) ),
                SLOT( fileDownloadSuccessful(const QString&) ) );
        this->connect(&wadseeker, SIGNAL( siteFinished(const QUrl&) ),
                SLOT( siteFinished(const QUrl&) ) );
        this->connect(&wadseeker, SIGNAL( siteProgress(const QUrl&, qint64, qint64) ),
                SLOT( siteProgress(const QUrl&, qint64, qint64) ) );
        this->connect(&wadseeker, SIGNAL( siteRedirect(const QUrl&, const QUrl&) ),
                SLOT( siteRedirect(const QUrl&, const QUrl&) ) );
        this->connect(&wadseeker, SIGNAL( siteStarted(const QUrl&) ),
                SLOT( siteStarted(const QUrl&) ) );
        this->connect(&wadseeker, SIGNAL( serviceStarted(QString) ),
                SLOT( serviceStarted(QString) ) );
        this->connect(&wadseeker, SIGNAL( serviceFinished(QString) ),
                SLOT( serviceFinished(QString) ) );

        // Connect Wadseeker to the WADs table widget.
        d->twWads->connect(&wadseeker, SIGNAL( fileDownloadFinished(const QString&) ),
                SLOT( setFileDownloadFinished(const QString&) ) );
        d->twWads->connect(&wadseeker, SIGNAL( fileDownloadProgress(const QString&, qint64, qint64) ),
                SLOT( setFileProgress(const QString&, qint64, qint64) ) );
        d->twWads->connect(&wadseeker, SIGNAL( fileDownloadStarted(const QString&, const QUrl&) ),
                SLOT( setFileUrl(const QString&, const QUrl&) ) );
}

void WadseekerInterface::construct()
{
        d->setupUi(this);
        d->preventGame = false;
        d->bCompletedSuccessfully = false;

        d->taskbarButton = new TaskbarButton(this);

        d->taskbarProgress = d->taskbarButton->progress();
        d->taskbarProgress->setMaximum(d->pbOverallProgress->maximum());

        setStateWaiting();

        initMessageColors();

        this->setWindowIcon(QIcon(":/icon.png"));
        d->btnStartGame->hide();
        this->connect(&updateTimer, SIGNAL(timeout()), SLOT(registerUpdateRequest()));

        connectWadseekerObject();

        // Connect tables.
        this->connect(d->twWads, SIGNAL( rightMouseClick(const QModelIndex&, const QPoint&) ),
                SLOT( wadsTableRightClicked(const QModelIndex&, const QPoint&) ) );

        bAutomatic = false;
        bFirstShown = false;

        QStringList urlList = gConfig.wadseeker.searchURLs;
        if (gConfig.wadseeker.bAlwaysUseDefaultSites)
        {
                for (int i = 0; !Wadseeker::defaultSites[i].isEmpty(); ++i)
                {
                        urlList << Wadseeker::defaultSites[i];
                }
        }

        wadseeker.setPrimarySites(urlList);

        updateTimer.setSingleShot(false);
        updateTimer.start(UPDATE_INTERVAL_MS);
}

WadseekerInterface *WadseekerInterface::create(QWidget* parent)
{
        if (!isInstantiated())
        {
                currentInstance = new WadseekerInterface(parent);
                return currentInstance;
        }
        return NULL;
}

WadseekerInterface *WadseekerInterface::create(ServerPtr server, QWidget* parent)
{
        if (!isInstantiated())
        {
                currentInstance = new WadseekerInterface(server, parent);
                return currentInstance;
        }
        return NULL;
}

WadseekerInterface *WadseekerInterface::createAutoNoGame(QWidget* parent)
{
        WadseekerInterface *interface = create(parent);
        if (interface != NULL)
        {
                interface->setupAutomatic();
                interface->d->preventGame = true;
        }
        return interface;
}

void WadseekerInterface::displayMessage(const QString& message, WadseekerLib::MessageType type, bool bPrependErrorsWithMessageType)
{
        QString strProcessedMessage;

        bool bPrependWithNewline = false;
        QString wrapHtmlLeft = "<div style=\"%1\">";
        QString wrapHtmlRight = "</div>";
        QString htmlStyle;

        switch (type)
        {
                case WadseekerLib::CriticalError:
                        htmlStyle = QString("color: %1; font-weight: bold;").arg(colorHtmlMessageFatalError);
                        bPrependWithNewline = true;

                        if (bPrependErrorsWithMessageType)
                        {
                                strProcessedMessage = tr("CRITICAL ERROR: %1").arg(message);
                        }
                        else
                        {
                                strProcessedMessage = message;
                        }

                        setStateWaiting();
                        break;

                case WadseekerLib::Error:
                        htmlStyle = QString("color: %1;").arg(colorHtmlMessageError);

                        if (bPrependErrorsWithMessageType)
                        {
                                strProcessedMessage = tr("Error: %1").arg(message);
                        }
                        else
                        {
                                strProcessedMessage = message;
                        }
                        break;

                case WadseekerLib::Notice:
                        htmlStyle = QString("color: %1;").arg(colorHtmlMessageNotice);

                        strProcessedMessage = message;
                        break;

                case WadseekerLib::NoticeImportant:
                        htmlStyle = QString("color: %1; font-weight: bold;").arg(colorHtmlMessageNotice);
                        bPrependWithNewline = true;

                        strProcessedMessage = message;
                        break;
        }

        if (bPrependWithNewline && !d->teWadseekerOutput->toPlainText().isEmpty())
        {
                strProcessedMessage = "<br>" + strProcessedMessage;
        }

        wrapHtmlLeft = wrapHtmlLeft.arg(htmlStyle);

        strProcessedMessage = wrapHtmlLeft + strProcessedMessage + wrapHtmlRight;

        d->teWadseekerOutput->append(strProcessedMessage);
}

void WadseekerInterface::fileDownloadSuccessful(const QString& filename)
{
        successfulWads << filename;
        d->twWads->setFileSuccessful(filename);
}

void WadseekerInterface::initMessageColors()
{
        colorHtmlMessageNotice = gConfig.wadseeker.colorMessageNotice;
        colorHtmlMessageError = gConfig.wadseeker.colorMessageError;
        colorHtmlMessageFatalError = gConfig.wadseeker.colorMessageCriticalError;
}

bool WadseekerInterface::isInstantiated()
{
        return currentInstance != NULL;
}

void WadseekerInterface::message(const QString& message, WadseekerLib::MessageType type)
{
        displayMessage(message, type, true);
}

void WadseekerInterface::registerUpdateRequest()
{
        updateProgressBar();
        updateTitle();
}

void WadseekerInterface::reject()
{
        switch(state)
        {
                case Downloading:
                        wadseeker.abort();
                        break;

                case Waiting:
                        this->done(Rejected);
                        break;
        }
}

void WadseekerInterface::resetTitleToDefault()
{
        setWindowTitle(tr("Wadseeker"));
}

void WadseekerInterface::seekStarted(const QStringList& filenames)
{
        d->teWadseekerOutput->clear();
        d->pbOverallProgress->setValue(0);
        d->taskbarProgress->setValue(0);
        displayMessage("Seek started on filenames: " + filenames.join(", "), WadseekerLib::Notice, false);

        seekedWads = filenames;
        successfulWads.clear();
        d->twSites->setRowCount(0);
        d->twWads->setRowCount(0);
        setStateDownloading();

        foreach (const QString& name, filenames)
        {
                d->twWads->addFile(name);
        }
}

void WadseekerInterface::setStateDownloading()
{
        d->btnClose->setText(tr("Abort"));
        d->btnDownload->setEnabled(false);
        d->taskbarProgress->show();
        state = Downloading;
}

void WadseekerInterface::setStateWaiting()
{
        d->btnClose->setText(tr("Close"));
        d->btnDownload->setEnabled(true);
        d->taskbarProgress->hide();
        state = Waiting;
}

void WadseekerInterface::setupAutomatic()
{
        bAutomatic = true;
        d->lblTop->hide();
        d->btnDownload->hide();
        d->leWadName->hide();
}

void WadseekerInterface::setWads(const QStringList& wads)
{
        if (isAutomatic())
        {
                seekedWads = wads;
        }
        else
        {
                d->leWadName->setText(wads.join(", "));
        }
}

void WadseekerInterface::setupIdgames()
{
        QString idgamesUrl = Wadseeker::defaultIdgamesUrl();
        bool useIdgames = true;

        useIdgames = gConfig.wadseeker.bSearchInIdgames;
        idgamesUrl = gConfig.wadseeker.idgamesURL;

        wadseeker.setIdgamesEnabled(useIdgames);
        wadseeker.setIdgamesUrl(idgamesUrl);
        wadseeker.setWadArchiveEnabled(gConfig.wadseeker.bSearchInWadArchive);
}

void WadseekerInterface::showEvent(QShowEvent* event)
{
        if (!bFirstShown)
        {
#if QT_VERSION >= 0x050000
                d->taskbarButton->setWindow(windowHandle());
#endif
                bFirstShown = true;

                if (isAutomatic())
                {
                        startSeeking(seekedWads);
                }
        }
}

void WadseekerInterface::serviceStarted(const QString &service)
{
        d->twSites->addService(service);
}

void WadseekerInterface::serviceFinished(const QString &service)
{
        d->twSites->removeService(service);
}

void WadseekerInterface::siteFinished(const QUrl& site)
{
        d->twSites->removeUrl(site);
        displayMessage("Site finished: " + site.toString(), WadseekerLib::Notice, false);
}

void WadseekerInterface::siteProgress(const QUrl& site, qint64 bytes, qint64 total)
{
        d->twSites->setUrlProgress(site, bytes, total);
}

void WadseekerInterface::siteRedirect(const QUrl& oldUrl, const QUrl& newUrl)
{
        d->twSites->removeUrl(oldUrl);
        d->twSites->addUrl(newUrl);
        displayMessage("Site redirect: " + oldUrl.toString() + " -> " + newUrl.toString(), WadseekerLib::Notice, false);
}

void WadseekerInterface::siteStarted(const QUrl& site)
{
        d->twSites->addUrl(site);
        displayMessage("Site started: " + site.toString(), WadseekerLib::Notice, false);
}

void WadseekerInterface::startSeeking(const QStringList& seekedFilesList)
{
        if (seekedFilesList.isEmpty())
        {
                return;
        }
        d->bCompletedSuccessfully = false;

        // Get rid of the whitespace characters from each filename; we don't want
        // to be searching " awad.wad".
        QStringList seekedFilesListFormatted;
        foreach (QString filenameFormatted, seekedFilesList)
        {
                filenameFormatted = filenameFormatted.trimmed();

                seekedFilesListFormatted << filenameFormatted;
        }

        setupIdgames();

        wadseeker.setTargetDirectory(gConfig.wadseeker.targetDirectory);
        wadseeker.setCustomSite(customSite);
        wadseeker.setMaximumConcurrentSeeks(gConfig.wadseeker.maxConcurrentSiteDownloads);
        wadseeker.setMaximumConcurrentDownloads(gConfig.wadseeker.maxConcurrentWadDownloads);
        wadseeker.startSeek(seekedFilesListFormatted);
}

void WadseekerInterface::updateProgressBar()
{
        double totalPercentage = d->twWads->totalDonePercentage();
        unsigned progressBarValue = (unsigned)(totalPercentage * 100.0);

        d->pbOverallProgress->setValue(progressBarValue);
        d->taskbarProgress->setValue(progressBarValue);
}

void WadseekerInterface::updateTitle()
{
        switch (state)
        {
                case Downloading:
                {
                        double totalPercentage = d->twWads->totalDonePercentage();
                        if (totalPercentage < 0.0)
                        {
                                totalPercentage = 0.0;
                        }

                        setWindowTitle(tr("[%1%] Wadseeker").arg(totalPercentage, 6, 'f', 2));
                        break;
                }

                default:
                case Waiting:
                        resetTitleToDefault();
                        break;
        }
}

QStringList WadseekerInterface::unsuccessfulWads() const
{
        QStringList allWads = seekedWads;

        foreach (const QString& success, successfulWads)
        {
                allWads.removeAll(success);
        }

        return allWads;
}

void WadseekerInterface::wadsTableRightClicked(const QModelIndex& index, const QPoint& cursorPosition)
{
        WadseekerWadsTable::ContextMenu* menu = d->twWads->contextMenu(index, cursorPosition);

        // Disable actions depending on Wadseeker's state.
        QString fileName = d->twWads->fileNameAtRow(index.row());
        if (!wadseeker.isDownloadingFile(fileName))
        {
                menu->actionSkipCurrentSite->setEnabled(false);
        }

        QAction* pResult = menu->exec();

        if (pResult == menu->actionSkipCurrentSite)
        {
                QString wadName = d->twWads->fileNameAtRow(index.row());
                d->twWads->setFileUrl(fileName, QUrl());

                wadseeker.skipFileCurrentUrl(wadName);
        }
        else if (pResult != NULL)
        {
                QMessageBox::warning(this, tr("Context menu error"), tr("Unknown action selected."));
        }

        delete menu;
}