connectionhandler.cpp

//------------------------------------------------------------------------------
// connectionhandler.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) 2012 Braden "Blzut3" Obrzut <admin@maniacsvault.net>
//                    "Zalewa" <zalewapl@gmail.com>
//------------------------------------------------------------------------------
#include "connectionhandler.h"

#include "application.h"
#include "apprunner.h"
#include "configuration/doomseekerconfig.h"
#include "gamedemo.h"
#include "gui/configuration/doomseekerconfigurationdialog.h"
#include "gui/configuration/gameconfigerrorbox.h"
#include "gui/mainwindow.h"
#include "joincommandlinebuilder.h"
#include "log.h"
#include "plugins/engineplugin.h"
#include "plugins/pluginloader.h"
#include "refresher/canrefreshserver.h"
#include "refresher/refresher.h"
#include "serverapi/gameclientrunner.h"
#include "serverapi/message.h"
#include "serverapi/server.h"
#include "strings.hpp"
#include <QDesktopServices>
#include <QMessageBox>
#include <QTimer>
#include <QUrl>

DClass<ConnectionHandler>
{
public:
        bool forceRefresh;
        ServerPtr server;
        QWidget *parentWidget;
};

DPointered(ConnectionHandler)

ConnectionHandler::ConnectionHandler(ServerPtr server, QWidget *parentWidget)
        : QObject(parentWidget)
{
        d->forceRefresh = false;
        d->server = server;
        d->parentWidget = parentWidget;
}

ConnectionHandler::~ConnectionHandler()
{
}

void ConnectionHandler::checkResponse(const ServerPtr &server, int response)
{
        server->disconnect(this);
        if (response != Server::RESPONSE_GOOD)
        {
                switch (response)
                {
                case Server::RESPONSE_TIMEOUT:
                        QMessageBox::critical(d->parentWidget, tr("Doomseeker - join server"),
                                tr("Connection to server timed out."));
                        break;
                default:
                        QMessageBox::critical(d->parentWidget, tr("Doomseeker - join server"),
                                tr("An error occured while trying to connect to server."));
                        break;
                }
                finish(response);
                return;
        }

        // Since we're potentially arriving from a deeply nested network recv,
        // it will be best to give the call stack a breather and continue execution
        // from the next iteration of the main loop.
        // This fixes a crash reported as #3268.
        QTimer::singleShot(0, this, SLOT(buildJoinCommandLine()));
}

ConnectionHandler *ConnectionHandler::connectByUrl(const QUrl &url)
{
        gLog << QString("Attempting to connect to server: %1").arg(url.toString());

        // Locate plugin by scheme
        const EnginePlugin *handler = nullptr;
        // For compatibility with IDE's zds://.../<two character> scheme
        bool zdsScheme = url.scheme().compare("zds", Qt::CaseInsensitive) == 0;
        for (unsigned int i = 0; i < gPlugins->numPlugins(); ++i)
        {
                const EnginePlugin *plugin = gPlugins->plugin(i)->info();
                if (plugin->data()->scheme.compare(url.scheme(), Qt::CaseInsensitive) == 0 ||
                        (zdsScheme && plugin->data()->scheme.left(2).compare(url.path().mid(1), Qt::CaseInsensitive) == 0))
                {
                        handler = plugin;
                        break;
                }
        }
        if (handler == nullptr)
        {
                gLog << "Scheme not recognized starting normally.";
                return nullptr;
        }

        unsigned short port = url.port(handler->data()->defaultServerPort);
        QString address;
        // We can get the port through QUrl so we'll just create a temporary variable here.
        unsigned short tmp;
        Strings::translateServerAddress(url.host(), address, tmp, QString("localhost:10666"));

        // Create the server object
        ServerPtr server = handler->server(QHostAddress(address), port);
        ConnectionHandler *connectionHandler = new ConnectionHandler(server, nullptr);
        connectionHandler->d->forceRefresh = true;

        return connectionHandler;
}

void ConnectionHandler::finish(int response)
{
        emit finished(response);
}

void ConnectionHandler::buildJoinCommandLine()
{
        JoinCommandLineBuilder *builder = new JoinCommandLineBuilder(d->server,
                gConfig.doomseeker.bRecordDemo ? GameDemo::Managed : GameDemo::NoDemo,
                d->parentWidget);
        this->connect(builder, SIGNAL(commandLineBuildFinished()), SLOT(onCommandLineBuildFinished()));
        builder->obtainJoinCommandLine();
}

void ConnectionHandler::onCommandLineBuildFinished()
{
        auto builder = static_cast<JoinCommandLineBuilder *>(sender());
        CommandLineInfo builtCli = builder->builtCommandLine();
        if (builtCli.isValid())
        {
                runCommandLine(builtCli);
        }
        else if (!builder->error().isEmpty())
        {
                GameConfigErrorBox::show(d->server->plugin(),
                        tr("Doomseeker - join game"), builder->error(),
                        builder->isConfigurationError());
        }
        builder->deleteLater();
        finish(Server::RESPONSE_GOOD);
}

void ConnectionHandler::runCommandLine(const CommandLineInfo &cli)
{
        Message message = AppRunner::runExecutable(cli);
        if (message.isError())
        {
                gLog << tr(R"(Error while launching game "%2" for server "%1": %3)")
                        .arg(d->server->name()).arg(d->server->engineName()).arg(message.contents());
                QMessageBox::critical(d->parentWidget, tr("Doomseeker - launch game"), message.contents());
        }
}

void ConnectionHandler::refreshToJoin()
{
        // If the data we have is old we should refresh first to check if we can
        // still properly join the server.
        CanRefreshServer refreshCheck(d->server.data());
        if (d->forceRefresh || (refreshCheck.shouldRefresh() && gConfig.doomseeker.bQueryBeforeLaunch))
        {
                this->connect(d->server.data(), SIGNAL(updated(ServerPtr,int)),
                        SLOT(checkResponse(ServerPtr,int)));
                gRefresher->registerServer(d->server.data());
        }
        else
                checkResponse(d->server, Server::RESPONSE_GOOD);
}

void ConnectionHandler::run()
{
        refreshToJoin();
}

// -------------------------- URL Handler -------------------------------------

PluginUrlHandler *PluginUrlHandler::instance = nullptr;

void PluginUrlHandler::registerAll()
{
        for (unsigned int i = 0; i < gPlugins->numPlugins(); ++i)
                registerScheme(gPlugins->plugin(i)->info()->data()->scheme);

        // IDE compatibility
        registerScheme("zds");
}

void PluginUrlHandler::registerScheme(const QString &scheme)
{
        if (!instance)
                instance = new PluginUrlHandler();

        QDesktopServices::setUrlHandler(scheme, instance, "handleUrl");
}

void PluginUrlHandler::handleUrl(const QUrl &url)
{
        if (QMessageBox::question(nullptr, tr("Connect to server"),
                tr("Do you want to connect to the server at %1?").arg(url.toString()),
                QMessageBox::Yes | QMessageBox::No, QMessageBox::No) == QMessageBox::Yes)
        {
                ConnectionHandler::connectByUrl(url);
        }
}